Zoho Voice SMS REST API
senderId
number
SenderId：
•短縮番号（OA長20）
•英数字の送信者（OA長20）
•MSISDNの最大長（OA長20）
customerNumber *
number
送信先の電話番号です。
（コンマ区切りの番号を指定できます）
message *
string
送信するメッセージの内容です。
最大10,000文字まで指定できます。
statusCallback
url
指定したURLにコールバックのステータスを通知します。
メモ：これはURLレベルの認証のみを使用します。
例：https://zoho.com/callback?zapikey=1003.5XXXXXXX59
dataCoding
整数
Unicode文字を検出するかどうか
0 - 日本語文字
1 - バイナリ
2 - 日本語以外の文字
validityPeriod
整数
指定した場合、プラットフォームはこの分数の間だけメッセージの送信を試行します。0～14,400分の範囲で指定してください。
scheduledTime
文字列
指定した時刻にメッセージが配信されるようにスケジュールします（例：yyyy-mm-DD hh:MM:ss）
timeZone
文字列
指定したタイムゾーンでメッセージが配信されるようにスケジュールします（例：Asia/kolkata）
flash
真偽値
メッセージを画面に直接表示するよう送信します
- {
- 'customerNumber':'13239205839',
- 'message':'単一SMSのテスト',
- 'statusCallback': 'https://eno0q0f3dwwls.x.pipedream.net',
- 'scheduledTime': '2022-08-27 22:24:38',
- 'timeZone' : 'Asia/Kolkata',
- 'flash':true
- }
レスポンス
成功
{
'code': 'ZVSMS-2000',
'send': {
'multipartCount': 1,
'country': 'in',
'submittedTime': 1667381258698,
'customerNumber': '+1 8XXXXXXXX7',
'message': 'テスト',
'userName': 'Mark',
'customerName': 'Henry',
'senderId': '14XXXXXXXXX3',
'messageType': 'OUTGOING',
'sentTime': '2022-11-02 14:57',
'logid': '40318437-aae8-4c91-bd1c-de52f8535445',
'メール': 'mark@ジルカー.com',
'status': 'IN_QUEUE'
},
'status': 'SUCCESS'
}
失敗
{
'code': 'ZVSMS-4038',
'message': '送信先の国はサポートされていません。Zoho Voiceサポートにお問い合わせください',
'status': 'ERROR'
}
スコープ：ZohoVoice.sms.CREATE
dataSet パラメーター
レスポンス
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',
'メール': 'mark@ジルカー.com',
'status': 'IN_QUEUE'
},
'status': 'SUCCESS'
}
}
SMSログの取得
このAPIを使用してSMSログを取得します。
スコープ：ZohoVoice.sms.READ
dataSet パラメーター
messageType
string
メッセージの方向
指定可能な値は all|incoming|outgoing
customerNumber
long
宛先アドレス
country
string
国名（例：US | EU）
レスポンス
成功
{
'smsLogQuery': [
{
'country': 'us',
'multipartCount': 1,
'submittedTime': 1702035249667,
'isBlocked': false,
'emailId': 'mark@ジルカー.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@ジルカー.com',
'customerNumber': '+1 46XXXXXXXX0',
'message': 'これは新規です',
'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'
}
失敗
{
'code': 'ZVSMS-4038',
'message': 'Destination country not supported. Kindly contact zohovoice support',
'status': 'ERROR'
}
説明：
このAPIは、MMSデータをストリームレスポンスとして提供します。
スコープ：ZohoVoice.sms.READ
dataSet パラメーター
SMSの会話ビュー
このAPIを使用して、会話ビューでSMSログを取得します
スコープ：ZohoVoice.sms.READ
dataSet パラメーター
page
整数
ページ番号
size
整数
データ配列のサイズ。初期値は100です
shortCode
文字列
ZohoVoiceショートコード
longCode
文字列
ZohoVoice SMS DID番号（+1 484292xxxx）
totalPages
整数
総ページ数
search
文字列
SMSテキストを完全な単語として検索します
レスポンス
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',
'メール': 'mark@ジルカー.com',
'status': 'UNDELIVERED'
},
{
'country': 'in',
'submittedTime': 1656057523864,
'messageId': '39ddc103-587f-4034-81c7-8b16d4842345',
'customerNumber': '+1 2XXXXXXXXX0',
'message': 'テストSMS',
'userName': 'mark@ジルカー.com',
'customerName': '+1 14XXXXXXXX0',
'zuid': 8956275,
'senderId': '',
'statusDescription': 'タイマーまたは有効期間の期限切れにより、メッセージは配信されませんでした',
'messageType': 'OUTGOING',
'sentTime': '2022-06-23 20:58',
'logid': 'eeb4352e-e0bd-4c42-b31d-56dd1d5f07d9',
'zsoid': '696913717',
'メール': 'mark@ジルカー.com',
'status': 'EXPIRED'
}
],
'meta': {
'total': 20,
'totalPages': 2
},
'status': 'success'
}
予約SMSの表示
このAPIを使用して、予約済みSMSを取得します。
スコープ：ZohoVoice.sms.READ
dataSet パラメーター
レスポンス
SUCCESS
{
'schedule': [
{
'multipartCount': 1,
'country': 'us',
'scheduledTime': '2023-03-04 21:35:00',
'timeZone': 'Pacific/Niue',
'customerNumber': '+1 46XXXXXXXX0',
'message': 'これは予約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'
}