• INST Voice API

    INST Voiceを利用するためのAPIです

    Request method

    HTTP GET/POST

     

    Request headers

    Content-Type: application/x-www-form-urlencoded

     

    Request endpoint

    https://voice.inst-inc.com/api/call/

     

    Request Example

    https://voice.inst-inc.com/api/call/?api_key=1234abcd&api_secret=5678efgh&client_id=001&client_number=0312345678&customer_number=09098765432

     

    Parameters

    Response example

     

    {
    "call_id":"0000100000000001",
    "client_id":"001",
    "client_number":"0312345678",
    "customer_number":"09098765432",
    "client_only":0,
    "no_say_cystomer_number": 0,
    "status":"01",
    "date":"2015-06-01 12:05:44"
    }

     

    ※call_idはリクエストに対してシステムから自動で割り振られるIDです

     

     

    Status code

    01:正常に処理が完了

    02:リクエストパラメタ(必須パラメタ)が不足

    03:認証エラー

    04:電話番号が不正

    05:client_idが不正

    09:その他のエラー

    10:リクエスト保留中(回線が空き次第client_numberに架電)

    CallBack URL for VoiceCall result

    CallBackURLを管理画面に設定するとINST Voiceで行ったVoice callの結果ステータスなどを受け取ることができます。

    ※1分毎に確定分のリクエストをまとめて送信します

    send_at:callback送信時のサーバ時間

    call_duration:通話時間(単位:秒)

    call_price:通話料金(単位:円)

    result_code:結果コード

     

    結果コード一覧