SparkTG

エージェントの更新(v2)ドキュメント

エージェントの更新(v2)

v2

エージェントの更新(v2)

ログイン、ログアウト、休憩、プロフィール変更

API v2v21件のエンドポイント

概要

エージェントのログイン/ログアウト、休憩への切り替え、電話番号・国番号・表示名の変更ができます。これは PATCH /api/v1/agents を置き換えるものです。agent_number または agent_sip のどちらか一方だけでエージェントを指定し、変更するフィールドを少なくとも 1 つ送信してください。省略したフィールドは変更されません。ボディは JSON で、以下に記載のないフィールドは 400 で拒否されます。null と空文字列は拒否され、このエンドポイントでは何も消去されません。成功した呼び出しは 1 回として課金されます。

利用可能なエンドポイント

PUT/api/v2/agents

主なパラメーター

agent_number(String)

エージェントの現在の電話番号。agent_sip とどちらか一方のみ送信してください。

agent_sip(String)

エージェントの SIP 内線番号。agent_number とどちらか一方のみ送信してください。

status(Integer)

0 でエージェントをログイン(対応可能)にします。2 でログアウト(オフライン)にするか、break_id を指定した場合はその休憩に入れます。これ以外の値は受け付けられません。

break_id(Integer)

エージェントを入れる休憩。サービスで有効になっている休憩である必要があります。break_id を送るとステータス 2 とみなされ、ステータス 0 とは併用できません。ステータス 2 で break_id がない場合は、既定の休憩 7(オフライン)が使われ、エージェントはログアウトします。

number(String)

新しい電話番号:4〜15 桁、+・スペース・ハイフンなし。サービス内の他のエージェントの番号と重複してはいけません。エージェントが通話中は変更できません。

country_code(String)

+ を除く 1〜4 桁で、0 で始まらないもの。例:91、971。

利用シナリオ

エージェントをログインさせる

status を 0 に設定します。エージェントは対応可能になり、キューからの着信を受け始めます。どの休憩中でも、この操作で復帰できます。

0件のパラメーターサンプルに掲載

エージェントをログアウトさせる

break_id なしで status を 2 に設定します。エージェントはオフライン(休憩 7)になり、着信を受けなくなります。status 2 と break_id 7 の組み合わせでも同じ結果になります。

0件のパラメーターサンプルに掲載

エージェントを休憩に入れる

break_id を送信します。status 2 は暗黙的に指定されます。再びログインするまで、エージェントは着信を受けません。ここでは SIP 内線番号ではなく電話番号でエージェントを指定しています。

0件のパラメーターサンプルに掲載

休憩から別の休憩へ切り替える

エージェントは休憩から別の休憩へ直接移れません。その呼び出しは 409 を返します。先にログイン(status 0)させてから、新しい break_id を送信してください。どちらの呼び出しも安全に再試行できます。

0件のパラメーターサンプルに掲載

プロフィール情報を更新する

名前、電話番号、国番号をまとめて変更します。プロフィールのフィールドは status や break_id と同じ呼び出しで送信できますが、エージェントが通話中は番号を変更できません。

0件のパラメーターサンプルに掲載

簡単なサンプル

簡単なcURLコマンドでこのAPIを試す

基本的なAPI呼び出し
curl -X PUT 'https://telephonycloud.co.in/api/v2/agents' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"agent_sip": "10114", "status": 0}'
💡 <YOUR_TOKEN> をお使いの API トークンに置き換えてください

レスポンスのプレビュー

このAPIのサンプルレスポンス

サンプルレスポンス
{"status":"success","changed":["status","break_id"],"agent":{"id":735,"name":"Priya Sharma","number":"9876500000","country_code":"91","sip":"10114","status":2,"break_id":3}}
レスポンス全体の形式はレスポンスセクションをご覧ください