Contacts API
Contact CRUD APIs
Authorization
HeaderKey | Description |
Authorization * | Zoho-oauthtoken<space><ACCESS_TOKEN> |
Accept * | Set to application/json. |
*All APIs are accessible under zohovoice.contacts.ALL scope.
Create Contact
Use this API to create a contact record.
POST https://voice.zoho.com/rest/json/zv/contacts |
Scope: zohovoice.contacts.CREATE
Param Name | DataType | Description |
contact * | string | Contact data as json. first_name and mobile keys are mandatory. JSON Schema: {"first_name":"<string>","last_name":"<string>","email":"<string>","mobile":"<string>","mobile1":"<string>","mobile2":"<string>","mobile3":"<string>","phone":"<string>","phone1":"<string>","phone2":"<string>","phone3":"<string>","company":"<string>","address":"<string>","state":"<string>","country":"<string>","is_favourite":"<string>","is_spam":"<string>","contact_status":{"id":"<id of status>","display_value":"<display value of status>"}}
|
{
"code": "200",
"contacts": {
"country": "",
"created_time": 1728037831825,
"is_spam": "",
"address": "",
"mobile": "+12015550123",
"mobile1": "",
"phone2": "",
"last_name": "",
"phone3": "",
"is_favourite": "",
"contact_id": 315000153768793,
"phone1": "",
"number": [
"+12015550126"
],
"phone": "",
"mobile3": "",
"mobile2": "",
"contact_owner": 415005010526109,
"company": "",
"state": "",
"first_name": "test",
"email": ""
},
"status": "SUCCESS"
}
FAILURE
{
"code": "<App Error Code>",
"message": "<Error Message>",
"status": "ERROR"
}
Get All Contact Status
Use this API to get contact statuses.
GET https://voice.zoho.com/rest/json/zv/contacts/contact_status |
Scope: zohovoice.contacts.READ
Response
SUCCESS
{
"code": "200",
"contact_status": [
{
"display_value": "Active",
"id": "1000000000027"
},
{
"display_value": "In Active",
"id": "1000000000029"
},
{
"display_value": "VIP",
"id": "1000000000031"
}
],
"status": "SUCCESS"
}
{
"code": "<App Error Code>",
"message": "<Error Message>",
"status": "ERROR"
}
Get All Contacts
Use this API to get contacts.
GET https://voice.zoho.com/rest/json/zv/contacts |
Scope: zohovoice.contacts.READ
Parameters
Param Name | DataType | Description |
totalCount | boolean | true/false (In case total count is needed) |
from | integer | 0 |
size | integer | 1-50 |
Response
{
"code": "200",
"meta": {
"total": -1
},
"contacts": [
{
"country": "",
"is_spam": "",
"address": "",
"mobile": "+15135493562",
"mobile1": "",
"phone2": "",
"last_name": "8Foller",
"phone3": "",
"is_favourite": "",
"contact_id": "347000014281004",
"phone1": "",
"phone": "+15135495601",
"mobile3": "",
"contact_owner": {
"display_value": "Vignesh",
"id": "347000000003015"
},
"mobile2": "",
"company": "",
"state": "",
"first_name": "Andrej",
"email": ""
},
{
"country": "",
"is_spam": "",
"address": "",
"mobile": "+18562644130",
"mobile1": "",
"phone2": "",
"last_name": "91Venere",
"phone3": "",
"is_favourite": "",
"contact_id": "347000014281005",
"phone1": "",
"phone": "+18566368749",
"mobile3": "",
"contact_owner": {
"display_value": "Vignesh",
"id": "347000000003015"
},
"mobile2": "",
"company": "",
"state": "",
"first_name": "Art",
"email": ""
}
],
"status": "SUCCESS"
}
{
"code": "<App Error Code>",
"message": "<Error Message>",
"status": "ERROR"
}
Delete a Contact
Use this API to delete a contact record.
DELETE https://voice.zoho.com/rest/json/zv/contacts/<contact_id> |
Scope: zohovoice.contacts.DELETE
Response
SUCCESS
{
"code": "200",
"contacts": "<contact_id>",
"status": "SUCCESS"
}
FAILURE
{
"code": "<App Error Code>",
"message": "<Error Message>",
"status": "ERROR"
}
Get a Contact
Use this API to get a contact record.
GET https://voice.zoho.com/rest/json/zv/contacts/<contact_id> |
Scope: zohovoice.contacts.READ
Response
SUCCESS
{
"code": "200",
"contacts": {
"country": "",
"created_time": 1728037831825,
"is_spam": "",
"address": "",
"mobile": "+12015550123",
"mobile1": "",
"phone2": "",
"last_name": "",
"phone3": "",
"is_favourite": "",
"contact_id": 315000153768793,
"phone1": "",
"number": [
"+12015550126"
],
"phone": "",
"mobile3": "",
"mobile2": "",
"contact_owner": 415005010526109,
"company": "",
"state": "",
"first_name": "test",
"email": ""
},
"status": "SUCCESS"
}
{
"code": "<App Error Code>",
"message": "<Error Message>",
"status": "ERROR"
}
Update a Contact
Use this API to update a contact record.
PUT https://voice.zoho.com/rest/json/zv/contacts/<contact_id> |
Scope: zohovoice.contacts.UPDATE
Parameters
Param Name | DataType | Description |
contact * | string | Contact data as json. first_name and mobile keys are mandatory. JSON Schema: {"first_name":"<string>","last_name":"<string>","email":"<string>","mobile":"<string>","mobile1":"<string>","mobile2":"<string>","mobile3":"<string>","phone":"<string>","phone1":"<string>","phone2":"<string>","phone3":"<string>","company":"<string>","address":"<string>","state":"<string>","country":"<string>","is_favourite":"<string>","is_spam":"<string>","contact_status":{"id":"<id of status>","display_value":"<display value of status>"}} Get available contact statuses from the get contact status API. |
SUCCESS
{
"code": "200",
"contacts": {
"country": "",
"created_time": 1728037831825,
"is_spam": "",
"address": "",
"mobile": "+12015550123",
"mobile1": "",
"phone2": "",
"last_name": "",
"phone3": "",
"is_favourite": "",
"contact_id": 315000153768793,
"phone1": "",
"number": [
"+12015550126"
],
"phone": "",
"mobile3": "",
"mobile2": "",
"contact_owner": 415005010526109,
"company": "",
"state": "",
"first_name": "test",
"email": ""
},
"status": "SUCCESS"
}
{
"code": "<App Error Code>",
"message": "<Error Message>",
"status": "ERROR"
}
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:
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
Zoho DataPrep Resources
Design. Discuss. Deliver.
Related Articles
Zoho Voice SMS REST API
Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. OAuth Doc Send SMS Use this API to send SMS POST https://voice.zoho.com/rest/json/v1/sms/send Scope : ZohoVoice.sms.CREATE ...Power Dialer API
Create Power Dialer Use this API to create Power Dialer campaign. POST https://voice.zoho.com/rest/json/zv/api/powerdialer OAuth Scope: ZohoVoice.powerdialer.ADD Parameters Param Name DataType Description name string campaign name break_duration_secs ...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 ...Agent Status Metrics API
ZohoVoice REST API Authorization HeaderKey Description Authorization * Zoho-oauthtoken<space><ACCESS_TOKEN> Accept * Set to application/json. OAuth Doc GET AGENT'S ONLINE STATUS AUDIT This API fetches the status details of an agent during a given ...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. ...