Execute a bot

Executes the specified version of a bot.

Resource URL:

POST https://api.essential.to/bots/v1/execute/{bot_sid}/{version}

Resource information:

Response formatJSON
Requires authentication?Yes



Content of the message to send to the bot.


Subscriber to whom the simulated input / responses should be attributed. By default, the phone number associated with the account being used to call this API will be used. The subscriber will not get a message on their phone, but it will be recorded as if they had sent in the message. This allows you to know what subscriber to query when testing the results.

Sample code:

curl -X POST \
 -u '[SID]:[TOKEN]' \
 -H 'Content-Type: application/json' \
 'https://api.essential.to/bots/v1/execute/M023pJRT9yNmt-5RjTQBwQ/1' \
 -d '{"body": "Help"}'

# Sample response
  "bot_id": 9,
  "bot_version_id": 13,
  "status": "success",
  "error_message": null,
  "execution_started_at": "2017-02-22T23:24:02.888Z",
  "execution_duration_ms": 104,
  "http_request_count": 0,
  "created_at": "2017-02-22T23:24:02.994Z",
  "updated_at": "2017-02-22T23:24:02.994Z",
  "error_backtrace": null,
  "sid": "sRhvpNDGZwyDeH-YRZIr9A"
Python coming soon.
Node coming soon.