Sign in

v1

latestOpenAPI 3.0.02026-07-14362240.2 KB
telephony

Start a phone call

Initiates a new phone call event. Used to track and manage telephony integration calls.

post/messenger/v1/telephony/call/start

Request body

call_type'incoming' | 'outgoing' required

Call type

fromstring required

Call from

tostring required

Call to

call_event_idnumber required

Call event id

auth_user_idnumber required

Auth user id

integration_codestring required

Integration code

timestring required

Hangup button

statusstring required

Status

notestring

Note

Example request

{
  "call_type": "incoming",
  "from": "1234567890",
  "to": "1234567890",
  "call_event_id": 1,
  "auth_user_id": 1,
  "integration_code": "1234567890",
  "time": "1234567890",
  "status": "1234567890",
  "note": "1234567890",
  "hangup_button": {
    "url": "https://example.com/hangup",
    "data": {
      "id": 1
    }
  }
}

Response

Call started successfully