Navigate the API Documentation using the menu on the left or by using the search function.
Navigate the API Documentation using the menu on the left or by using the search function.
All API requests require an API Key which is to be included in the headers of each request.
Example:
curl --location --request GET 'https://api.itp360.com/public/voice360/v2/{{account_id}}' \
--header 'Authorization: 9V1xdVfs666999420'
Get assigned numbers for Messaging
URL: {{base_url}}
/public/voice360/v2/{{account_id}}
/my-extension/chat/numbers
Method: GET
Response
{
"result": [
{
"status": "active",
"owner_id": 111,
"sms_assigned_users": [
],
"caller_id_name": "",
"description": "",
"number": "+13475555555",
"callerid_prefix": "",
"fax_assigned_users": [],
"pk": 999,
"account_id": 1,
"used_by": "callflow"
}
],
"errors": false,
"error": null,
"message": "List of Numbers Assigned to User"
}
Endpoint for sending a message
URL: {{base_url}}
/public/voice360/v2/{{account_id}}
/my-extension/chat/sms/{{number}}
Method: POST
Payload:
Field Name | Description | Type | Example | Required |
---|---|---|---|---|
body | The content of the SMS message you want to send. | string | "This is a test message" | Yes |
from_number | The sender’s phone number in E.164 format. | string | "+15612210454" | Yes |
to_numbers_list | A JSON formatted list of recipient phone numbers, in E.164 format. | JSON string | "{\"list\":[\"+13052990233\"]}" | Yes |
item_type | Defines the type of message (SMS, Phone Call, Voicemail, etc.). | string | "sms" | Yes |
send_at | The date and time to send the message, in YYYY-MM-DD HH:MM:SS format. | string | "2024-08-19 20:33:30" | No |
Header Name | Description | Type | Required |
---|---|---|---|
Authorization | The API token needed for authenticating the request. | string | Yes |
Response
{
"error": null,
"errors": false,
"message": "Message Sent.",
"result": {
"call_answered_user_id": null,
"call_back_response": {},
"call_direction": null,
"call_duration": 0,
"call_status": null,
"call_uniqueid": null,
"item_type": "sms",
"message_body": "this is a test",
"message_error_code": null,
"message_error_description": null,
"message_mms_media": null,
"message_participant": "+15612210454",
"message_participant_id": "285891",
"message_provider_id": null,
"message_status": "pending_message_date",
"message_thread_id": 143921,
"message_timestamp": "2024-08-19T20:45:25.525723",
"mms_file_type": null,
"voicemail_duration": 0,
"voicemail_id": null,
"voicemail_link": null,
"voicemail_transcription": null
}
}