Send A Message

To send a text message to a given telephone number or a contact

• widget_id: Widget ID to be used for initiating the call. It must be connected to WhatsApp or SMS.
• to: phone number of the recipient. should contain the country code. For ex: 16501111234
• contact_id: contact ID to whom the message is to be sent. (either to or contact_id must be given)
• message: text message to be sent.
• start_new_conversation: whether to start a new conversation or pick the latest.

POST /api/v1/messaging/{widget_id}

Send A Message

cURL

curl --request POST \
  --url 'https://api.example.com/api/v1/messaging/{widget_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "start_new_conversation": true,
  "widget_parameters": {}
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Your API KeyHTTPBearer

api_key · string · query · required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

widget_id · string<uuid> · required

Body

application/json

to · string | null

contact_id · string<uuid> | null

message · string | null

start_new_conversation · boolean | null · default: true

widget_parameters · Widget Parameters · object

Response

200

application/json

Successful Response