v1

latestOpenAPI 3.0.42026-07-246086174.5 KB
Chatbots

Start chatbot (Available in Pro plan)

post/api/ext/v3/chatbots/start

Request body

targetstring required

The target recipient in the following formats:

  • ContactId: The unique ID of a contact.
  • PhoneNumber: The recipient's phone number (e.g., 14155552671).
  • Channel:ContactId: A combination of the channel (name or phone number) and the recipient's phone number (e.g., MyChannel:65b73810e2bd04aa867b5f7d, 123456789:65b73810e2bd04aa867b5f7d).
  • Channel:PhoneNumber: A combination of the channel (name or phone number) and the recipient's phone number (e.g., MyChannel:1415552671, 123456789:1415552671).
chatbot_idstring required

Chatbot ID.

Response

Returns the result of starting the chatbot.

resultboolean

Result of the chatbot start operation.