＜SMS（ショートメッセージ）プラットフォームAPI仕様＞
１．SMS送信（APIエンドポイント：テスト環境）
URL
| http://138.2.91.245:7788/sms/webService/restSmsService/smsService/sendSmsByPost |
▼Request
Method
POST
Content-Type
application/json
Body
|
パラメータ |
説明 |
| account | アカウント（SMSプラットフォームにより発行される） |
| password | パスワード（SMSプラットフォームにより発行される。MD5で暗号化する必要あり。最大32桁の小文字） |
| mobile | 携帯番号（国コードのプレフィックスが必要で、+は不要。複数番号はカンマで区切り） |
| content | メッセージ内容 |
| sid | SID（オプション） |
| templateId | テンプレートID（オプション） |
Payloadサンプル
|
{ "account": "testAccount", "password": "3564c2741bf69933d7801a2d59081125", "mobile": "8618810513046,8618810513047", "content": "テストメッセージです。" } |
▼Response
Content-Type
application/json
Body
|
パラメータ |
説明 |
| smsId | CloopenのSMSプラットフォームによって顧客ごとに割り当てられた一意な識別子 |
| subStat | ステータスコード。 r:000の場合、リクエストは正常に受け付けられたことを示す。他の値の場合、リクエストが失敗したことを示し、その場合はresDetailは設定されない |
| subStatDes | ステータスコードの説明 |
| content | メッセージ内容 |
| resDetail | 送信リクエストが成功した場合、各電話番号の送信リクエストのレスポンス情報 |
Responseサンプル
|
{ "smsId": "62c4f3ab-b572-4297-b177-60deafbeff51", "subStat": "r:000", "subStatDes": "送信が成功しました", "resDetail": [ { "phoneNumber": "8613800138000", "stat": "r:000", "statDes": "提出成功しました" }, { "phoneNumber": "8613800138001", "stat": "r:000", "statDes": "提出成功しました" } ] } |
２．送信のコールバック（APIエンドポイント：テスト環境）
URL
SMS利用者側が用意
▼Request
Method
POST
Content-Type
application/x-www-form-urlencoded
Body
|
パラメータ |
説明 |
| phone | 携帯番号 |
| msgid | メッセージID |
| nstat | ステータス。0：成功／0以外：失敗 |
| errcode | ステータスの説明 |
| revTime | 呼出し時間文字列。フォーマット：yyyy-MM-dd HH:mm:ss |
CloopenのSMSプラットフォームからSMS利用者側のエンドポイントへリクエストした後、SMS利用者側のエンドポイントより200のHTTPステータスコードを受け取った場合、コールバックが成功したとみなします。
ステータスコードが200以外だった場合、コールバックが失敗したと見なされます。成功のステータスが返されるまで、CloopenのSMSプラットフォームは3回までリクエストを繰り返します。
