v2

latestOpenAPI 3.1.02026-07-26231357386.7 KB

Messaging

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}

widget_idstring uuid required

tostring nullable

contact_idstring uuid nullable

messagestring nullable

start_new_conversationboolean nullable

widget_parametersobject nullable

conversation_idstring uuid nullable

{
  "message": "Hi, how are you?",
  "start_new_conversation": true,
  "to": "919810012345"
}

Successful Response

{"stackTrail":"paths:/api/v1/messaging/{widget_id}:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}