Zoho Voice SMS REST API
Authorization
Send SMS
Use this API to send SMS
Scope : ZohoVoice.sms.CREATE
dataSet Parameters
- {
- "customerNumber":"13239205839",
- "message":"test single SMS",
- "statusCallback": "https://eno0q0f3dwwls.x.pipedream.net",
- "scheduledTime": "2022-08-27 22:24:38",
- "timeZone" : "Asia/Kolkata",
- "flash":true
- }
Response
SUCCESS
{
"code": "ZVSMS-2000",
"send": {
"multipartCount": 1,
"country": "in",
"submittedTime": 1667381258698,
"customerNumber": "+1 8XXXXXXXX7",
"message": "TEST",
"userName": "Mark",
"customerName": "Henry",
"senderId": "14XXXXXXXXX3",
"messageType": "OUTGOING",
"sentTime": "2022-11-02 14:57",
"logid": "40318437-aae8-4c91-bd1c-de52f8535445",
"email": "mark@zylker.com",
"status": "IN_QUEUE"
},
"status": "SUCCESS"
}
FAILURE
{
"code": "ZVSMS-4038",
"message": "Destination country not supported. Kindly contact zohovoice support",
"status": "ERROR"
}
Scope : ZohoVoice.sms.CREATE
dataSet Parameters
Response
SUCCESS
{
"code": "ZVSMS-2000",
"send": {
"multipartCount": 1,
"country": "us",
"submittedTime": 1689851513187,
"customerNumber": "+1 4XXXXXXXXX73",
"message": "Hello,world!",
"userName": "Mark",
"customerName": "+1 4XXXXXXXX3",
"senderId": "+14XXXXXXXX90",
"messageType": "OUTGOING",
"isMMS": true,
"mmsMeta": [
{
"bucketName": "zohovoice-mms-test-6-15327576",
"fileName": "hd1970_preview.mp4",
"fileSize": 5125300,
"objectName": "hd1970_preview.mp4-1689851510892",
"fileExtn": "mp4",
"mmsId": "3dff6d5a-ed5d-416d-b24d-f5c3817862e4"
}
],
"sentTime": "2023-07-20 11:11",
"logid": "40318972-ffc8-4448-92ec-2f8494eafaa6",
"email": "mark@zylker.com",
"status": "IN_QUEUE"
},
"status": "SUCCESS"
}
}
Fetch SMS Logs
Use this API to fetch SMS logs
Scope : ZohoVoice.sms.READ
dataSet Parameters
Response
SUCCESS
{
"smsLogQuery": [
{
"country": "us",
"multipartCount": 1,
"submittedTime": 1702035249667,
"isBlocked": false,
"emailId": "mark@zylker.com",
"customerNumber": "+1 4XXXXXXXXX0",
"message": "Take this",
"userName": "Mark",
"customerName": "Josiah",
"zuid": 669069956,
"senderId": "+1 4XXXXXXXX73",
"messageType": "INCOMING",
"isMMS": true,
"mmsMeta": [
{
"bucketName": "zohovoice-mms-local-02-697950588",
"objectName": "697950588-mms-669069956-1702035250091",
"fileName": "697950588-mms-669069956-1702035250091",
"fileSize": "960637",
"mmsId": "6d39bf14-43cb-4cff-8a98-68ab1de26064",
"contentType": "image/jpeg"
}
],
"isLongCode": true,
"sentTime": "2023-12-08 17:04",
"logid": "953473b3-0b33-4d4e-a9c8-abf0ae8893c7",
"zsoid": "697950588",
"senderIdCountry": "us",
"senderIdName": "+1 46XXXXXXX73",
"status": "DELIVERED"
},
{
"country": "us",
"multipartCount": 1,
"submittedTime": 1702029127336,
"isBlocked": false,
"emailId": "mark@zylker.com",
"customerNumber": "+1 46XXXXXXXX0",
"message": "This is new",
"userName": "mark",
"customerName": "Josiah",
"zuid": 669069956,
"senderId": "+1 4XXXXXXXXX3",
"messageType": "INCOMING",
"isMMS": false,
"isLongCode": true,
"sentTime": "2023-12-08 15:22",
"logid": "bd1ed056-0662-4c1f-8074-10c05aab0b3a",
"zsoid": "697950588",
"senderIdCountry": "us",
"senderIdName": "+1 4XXXXXXXXX3",
"status": "DELIVERED"
}
],
"meta": {
"total": 4
},
"status": "success"
}
FAILURE
{
"code": "ZVSMS-4038",
"message": "Destination country not supported. Kindly contact zohovoice support",
"status": "ERROR"
}
Description:
This API provides the MMS data as stream response.
Scope : ZohoVoice.sms.READ
dataSet Parameters
SMS conversation view
Use this API to fetch SMS logs in conversation view
Scope : ZohoVoice.sms.READ
dataSet Parameters
Response
SUCCESS
{
"chatlist": [
{
"country": "au",
"submittedTime": 1656313040887,
"messageId": "61a2d48d-45bf-4583-a34c-44b8f924a61e",
"customerNumber": "+61 2XXXXXXXX7",
"message": "test AUS SMS",
"userName": "Mark",
"customerName": "+6XXXXXXXXX7",
"zuid": 8956275,
"senderId": "+61 4XXXXXXXX5",
"statusDescription": "Message was not delivered due to one of the possible errors reported by SMSC",
"messageType": "OUTGOING",
"sentTime": "2022-06-26 19:57",
"logid": "66fccfe8-95e6-4a39-bd1a-5f258755ed81",
"zsoid": "696913717",
"email": "mark@zylker.com",
"status": "UNDELIVERED"
},
{
"country": "in",
"submittedTime": 1656057523864,
"messageId": "39ddc103-587f-4034-81c7-8b16d4842345",
"customerNumber": "+1 2XXXXXXXXX0",
"message": "test SMS",
"userName": "mark@zylker.com",
"customerName": "+1 14XXXXXXXX0",
"zuid": 8956275,
"senderId": "",
"statusDescription": "Message was not delivered due to expiration of timer or validity period",
"messageType": "OUTGOING",
"sentTime": "2022-06-23 20:58",
"logid": "eeb4352e-e0bd-4c42-b31d-56dd1d5f07d9",
"zsoid": "696913717",
"email": "mark@zylker.com",
"status": "EXPIRED"
}
],
"meta": {
"total": 20,
"totalPages": 2
},
"status": "success"
}
Schedule SMS view
Use this API to fetch Schedules sms
Scope : ZohoVoice.sms.READ
dataSet Parameters
Response
SUCCESS
{
"schedule": [
{
"multipartCount": 1,
"country": "us",
"scheduledTime": "2023-03-04 21:35:00",
"timeZone": "Pacific/Niue",
"customerNumber": "+1 46XXXXXXXX0",
"message": "this is scheduled SMS",
"userName": "Mark",
"customerName": "John",
"zuid": 8956275,
"jobId": "961000000506031",
"senderId": "+1 48XXXXXXX30",
"messageType": "OUTGOING",
"countryCode": "us",
"isLongCode": true,
"logid": "32712527-db0a-4aa9-840d-d0d3d72f7d0b",
"zsoid": "696913717",
"senderIdCountry": "us",
"senderIdName": "SMS TATA US",
"status": "IN_QUEUE"
}
],
"code": "200",
"status": "SUCCESS"
}
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Create. Review. Publish.
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Design. Discuss. Deliver.
Related Articles
How to send SMS via Zoho Creator?
How to send Zoho Voice SMS via Zoho Creator? Follow the steps below to send automatic SMS via a Zoho Voice number directly from your Zoho Creator solutions. Step1 : Login to https://creator.zoho.com/ Step 2: To create connectors for your Creator ...Zoho Voice Recording API
Download Recording/VoiceMail API Use this API to download recording/voice mail files. Note: 1.The same API is used to download both voice mail and recording log files. The filename determines which file to download. 2. Threshold for this url - 30 ...Zoho Voice vs Zoho Telephony
Zoho Voice vs Zoho Telephony: Demystified In Zoho One or apps such as Zoho CRM, Desk, Recruit, and Bigin, there are two ways to configure the calling functionality (click-to-call and call pop-up features) using Zoho Telephony. One is using an ...Zoho Voice Call Logs API
Get Call log and Recording/VoiceMail API Use this API to get recording/voice mail. Note: 1. The same API is used for getting voice mail and recording files. Set Boolean value to the below mentioned respective keys to get respective files. 2. ...Zoho Voice Transcription API
Download Voicemail Transcription In File Authentication: OAuth Scope: ZohoVoice.call.READ GET https://voice.zoho.com/rest/json/zv/transcribe/download Query Parameters: logId string 33549725-33d3-40e2-b4b8-e8fac35023d8 Download Voicemail Transcription ...