SparkTG

エージェントのログイン/ログアウトドキュメント

エージェントのログイン/ログアウト

v1.0

エージェントのログイン/ログアウト

エージェントのステータスと稼働状況を管理します

エージェント管理v1.01件のエンドポイント

概要

PATCH /agents - エージェントのログイン/ログアウトステータスを制御します

認証

Basic認証

メソッド

PATCH

パラメーター

3件のパラメーター

レスポンス

JSON形式

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

PATCH/agents

主なパラメーター

status(Integer)

ステータス番号は、設定したいステータスの種類を示します。下記のステータス表をご参照ください

break(Integer)

休憩IDは、ステータスに対してどの種類の休憩を取るかを示します。下記の休憩表をご参照ください

agent-number(String)

ステータスを更新するエージェントの番号です。管理者の認証情報では、エージェントの番号を指定してそのステータスを変更できます

簡単なサンプル

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

基本的なAPI呼び出し
curl -X PATCH -u "username:password" https://telephonycloud.co.in/api/v1/agents?status=0
💡 username:passwordを実際の認証情報に置き換えてください

レスポンスのプレビュー

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

サンプルレスポンス
{"break":-1,"status":0}
レスポンス全体の形式はレスポンスセクションをご覧ください