Initiate an outbound call.
Method: POST
Endpoint: /omni/voice/{user_id}/call
System Authorization: Authorization: Key=your-auth-key
User Authentication: tokenKey: {token}
Paste code macro | ||||
---|---|---|---|---|
| ||||
{
"phone_number": <string>,
"lead_id": <integer>,
"outbound_cli": <string>,
"unique_id": <string>
} |
Field | Type | Description |
---|---|---|
phone_number | string | The phone number that must be dialed. |
lead_id | integer | [optional]The ID of the lead on the system. |
outboud_cli | string | The phone number to be displayed when dialing out. |
unique_id | string | The external unique ID for this call/lead. |
Paste code macro | ||||
---|---|---|---|---|
| ||||
{
"call_id": <int>,
"phone_number": <string>,
"call_state": <string>,
"call_start_time": <dateTime.ISO>
} |
Field | Type | Description |
---|---|---|
call_id | int | The unique id for the placed call. |
phone_number | string | The phone_number that was dialed. |
call_state | string | The state of the call. |
call_start_time | dateTime.ISO | The start time and date when the call was initiated. |