Contacts API

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

連絡先CRUD API

認証

ヘッダーキー	説明
Authorization *	Zoho-oauthtoken<space><ACCESS_TOKEN>
Accept *	application/jsonに設定します。

*すべてのAPIは次の zohovoice.contacts.ALL スコープで利用できます。

OAuthドキュメント

連絡先の作成

このAPIを使用して、連絡先データを作成します。

POST https://voice.zoho.com/rest/json/zv/contacts

スコープ：zohovoice.contacts.CREATE

パラメーター

パラメーター名

データ型

説明

contact *

文字列

JSON形式の連絡先データです。

first_nameキーとmobileキーは必須です。

JSONスキーマ。

{'first_name':'<string>','last_name':'<string>','メール':'<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>'}}

利用可能な連絡先ステータスは、下記の連絡先ステータス取得APIから取得できます。

レスポンス

成功

{

'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',

'メール': ''

'status': 'SUCCESS'

}

失敗

{

'code': '<App Error Code>',

'message': '<Error Message>',

'status': 'ERROR'

}

すべての連絡先ステータスの取得

このAPIを使用して、連絡先のステータスを取得します。

GET https://voice.zoho.com/rest/json/zv/contacts/contact_status

スコープ：zohovoice.contacts.READ

レスポンス

成功

{

'code': '200',

'contact_status': [

{

'display_value': '有効',

'id': '1000000000027'

{

'display_value': '無効',

'id': '1000000000029'

{

'display_value': 'VIP',

'id': '1000000000031'

}

'status': 'SUCCESS'

}

失敗

{

'code': '<App Error Code>',

'message': '<Error Message>',

'status': 'ERROR'

}

すべての連絡先の取得

このAPIを使用して連絡先を取得します。

GET https://voice.zoho.com/rest/json/zv/contacts

スコープ：zohovoice.contacts.READ

パラメーター

パラメーター名	データ型	説明
totalCount	boolean	true/false（合計件数が必要な場合）
from	integer	0
size	integer	1-50

レスポンス

成功

{

'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',

'メール': ''

{

'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',

'メール': ''

}

'status': 'SUCCESS'

}

失敗

{

'code': '<App Error Code>',

'message': '<Error Message>',

'status': 'ERROR'

}

連絡先の削除

このAPIを使用して、連絡先データを削除します。

削除 https://voice.zoho.com/rest/json/zv/contacts/<contact_id>

スコープ：zohovoice.contacts.削除

レスポンス

成功

{

'code': '200',

'contacts': '<contact_id>',

'status': 'SUCCESS'

}

失敗

{

'code': '<App Error Code>',

'message': '<Error Message>',

'status': 'ERROR'

}

連絡先の取得

このAPIを使用して、連絡先データを取得します。

GET https://voice.zoho.com/rest/json/zv/contacts/<contact_id>

スコープ：zohovoice.contacts.READ

レスポンス

成功

{

'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',

'メール': ''

'status': 'SUCCESS'

}

失敗

{

'code': '<App Error Code>',

'message': '<Error Message>',

'status': 'ERROR'

}

連絡先の更新

このAPIを使用して、連絡先データを更新します。

PUT https://voice.zoho.com/rest/json/zv/contacts/<contact_id>

スコープ：zohovoice.contacts.UPDATE

パラメーター

パラメーター名

データ型

説明

contact *

文字列

JSON形式の連絡先データです。

first_nameキーとmobileキーは必須です。

JSONスキーマ。

利用可能な連絡先ステータスは、連絡先ステータスの取得APIから取得できます。

レスポンス

成功

{

'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',

'メール': ''

'status': 'SUCCESS'

}

失敗

{

'code': '<App Error Code>',

'message': '<Error Message>',

'status': 'ERROR'

}