- SMS送信API
INST MessengerのSMS送信APIです
※API経由の場合、本文は70文字以上入力してリクエストすることは可能ですが、70文字を超えるごとに70文字単位で1通とみなして課金とさせていただきますのでご注意下さい。
※特にURLが文頭から71文字目にまたがる場合、端末によってはSMSのメッセージ吹き出しが2つに分かれてしまい、URLがクリックできなくなる可能性があります
Request method
HTTP GET/POST
Request headers
Content-Type: application/x-www-form-urlencoded
Request endpoint :
https://v1-message.inst-inc.com/commands/createRequest Example :
https://v1-message.inst-inc.com/commands/create?api_key=Abcdefgh&api_secret=Abc123def456&text=こちらはSMSの送信テストです&from=inst&to=09011112222:inst001:山田ひろし
Parameters
Response Examples
// success information{status: 0}// パラメータエラー
{
"status": 1,
"reason": "「text」のフォーマットが違います"
}
// 認証エラー
{
"status": 2,
"reason": "no user"
}
// サーバーエラー
{
"status": 99,
"reason": "Internal Server Error"
}
返信フォーム送信API
INST Messengerのオプション、返信フォームのURLを送信するためのAPIです
Request method
HTTP POST
Request headers
Content-Type: application/x-www-form-urlencoded
Request endpoint :
>https://v1-message.inst-inc.com/surveys/createRequest Example :
https://v1-message.inst-inc.com/surveys/create?api_key=Abcdefgh&api_secret=Abc123def456&text=返信フォームのテストです{{ survey }}&from=inst&to=09011112222:inst001:山田ひろし&survey_id=日程調整用A
Parameters
Response examples
Success
// success information{status: 0}// callback 先に渡されるJSONデータ{
"data": {
"answers": [
{
"answer": "A",
"name": "使った商品をお選びください。"
},
{
"answer": "満足していない",
"name": "満足度をお聞かせください。"
},
{
"answer": "特に無し",
"name": "ご質問などございましたらご入力ください。"
}
],
"customer": {
"label": "設楽",
"telehone": "090xxxxxxxx",
"name": "設楽"
},
"enquete": {
"id": "5bfb567873790xxxxxxxxxx"
},
"command": {
"id": "5dba73647c211xxxxxxxxxx"
}
},
"event": "survey/update"
}
Failed
// パラメータエラー { "status": 1, "reason": "「text」のフォーマットが違います" }// 認証エラー { "status": 2, "reason": "no user" }- ClickCallBack APIINST Messengerのオプション、ClickCallBackのURLを送信するためのAPIです
Request method
HTTP POST
Request endpoint :
>https://v1-message.inst-inc.com/homing/createRequest Example :
https://v1-message.inst-inc.com/homing/create?api_key=Abcdefgh&api_secret=Abc123def456&text=以下のURLをクリックしてください{{ callback }}&from=inst&to=09011112222:inst001:山田ひろし&homing_callback=0312345678&homing_sigunature=inst石野&homing_callback_message={{customer}}から電話の希望です。お繋ぎする場合は1を押してください。
Response
Success
// success information { status: 0 }Failed
// パラメータエラー { "status": 1, "reason": "「text」のフォーマットが違います" }// 認証エラー { "status": 2, "reason": "no user" }※通話ステータスの取得方法は現在作成中 - 送信履歴取得APISMSの送信履歴を取得するためのAPIです※管理画面からDLできる送信結果CSVと同じ形式のものが取得可能
Request method
HTTP POST
Request endpoint :
>https://v1-message.inst-inc.com/messages/historyRequest Example :
https://v1-message.inst-inc.com/messages/history?api_key=Abcdefgh&api_secret=Abc123def456&from=2021-01-01 00:00:00&to=2021-01-31 23:59:59&
- limit=50
- ※上記サンプルだと1/1-1/31の送信履歴を古いものから順に50件DLできます
- ※続けて50件取得したい場合は offset=50,limit=50と指定すると期間中の古いものから51~100件がDLできます
Copyright 2019 INST,Inc. All rights reserved