REST APIについて

Wipple CPaaS REST APIを使用すると、バックエンドシステムから通話の作成・照会・更新・終了を行い、アカウント上でアクティブな会議やキューを確認できます。

APIエンドポイント

すべてのリクエストは、アカウントに割り当てられたAPIエンドポイントへ送信します。本ドキュメントではホスト名を {API_ENDPOINT} と表記しており、ベースURLは次のとおりです。

https://{API_ENDPOINT}/v1

通話制御に関するすべてのリソースは、アカウントの配下に配置されます。

https://{API_ENDPOINT}/v1/Accounts/{AccountSid}/...

{AccountSid} はアカウントの識別子です。すべてのWebhookにも account_sid として含まれます。

認証

このAPIはベアラー認証を使用します。すべてのリクエストの Authorization ヘッダーにAPIキーを指定してください。

Authorization: Bearer <token>

APIキーはアカウント上の通話を完全に制御できる権限を持ちます。安全に保管し、クライアント側のコードには決して埋め込まないでください。

リクエスト形式

ボディを含むリクエストでは Content-Type: application/json を使用する必要があります。{AccountSid}、{CallSid}、{ConferenceName} などのパス要素は、実際の識別子に置き換えてください。

HTTPレスポンスコード

エラーは 4xx または 5xx のステータスで報告されます。ボディが返される場合は、問題の内容を説明する msg プロパティを持つJSONオブジェクトです。

{
  "msg": "call not found"
}

エンドポイント

通話

会議

キュー