エージェントの更新(v2)ドキュメント
エージェントの更新(v2)
エージェントの更新(v2)
エージェントの更新(v2)
ログイン、ログアウト、休憩、プロフィール変更
概要
利用可能なエンドポイント
/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 に設定します。エージェントは対応可能になり、キューからの着信を受け始めます。どの休憩中でも、この操作で復帰できます。
エージェントをログアウトさせる
break_id なしで status を 2 に設定します。エージェントはオフライン(休憩 7)になり、着信を受けなくなります。status 2 と break_id 7 の組み合わせでも同じ結果になります。
エージェントを休憩に入れる
break_id を送信します。status 2 は暗黙的に指定されます。再びログインするまで、エージェントは着信を受けません。ここでは SIP 内線番号ではなく電話番号でエージェントを指定しています。
休憩から別の休憩へ切り替える
エージェントは休憩から別の休憩へ直接移れません。その呼び出しは 409 を返します。先にログイン(status 0)させてから、新しい break_id を送信してください。どちらの呼び出しも安全に再試行できます。
プロフィール情報を更新する
名前、電話番号、国番号をまとめて変更します。プロフィールのフィールドは status や break_id と同じ呼び出しで送信できますが、エージェントが通話中は番号を変更できません。
簡単なサンプル
簡単なcURLコマンドでこの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}'レスポンスのプレビュー
この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}}