ウェブコールバック開始インターフェース

このインターフェースはウェブコールバックを開始するために使用され、まず顧客に発信し、次にカスタマーサポートに発信します（着信として扱われます）。

リクエストメソッド

POST /callcenter/web_callback

リクエストパラメータ

パラメータ名 必須 型 説明 制限
from_number はい 文字列 発信者番号（顧客番号）
to_number はい 文字列 着信者番号（中継番号）
variables いいえ JSON 付帯カスタム変数（インテリジェントルーティングIVRパスで変数として設定して使用できます。変数の値は文字列または数字のみ可能です）

返却結果

属性名 型 説明
code 整数型 実行結果コード
1000 # 成功を表します

例

curl https://demo.udesk.cn/open_api_v1/callcenter/web_callback?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type:application/json' \
-d '
{
"from_number": "13666666666",
"to_number": "01086465040",
"variables": {
"key1": 123,
"key2": "13200000000"
}
} '

返却

{
    "code": 1000
}

コールセンター中継番号リスト取得

このインターフェースは、コールセンターの中継番号リストを取得するために使用されます。

リクエストメソッド

GET /callcenter/callout_number_list

リクエストパラメータ

パラメータ名 必須 型 説明 制限
page いいえ 整数型 ページ番号、1から開始、デフォルトは1
per_page いいえ 整数型 1ページあたりの件数、デフォルト10、最大100

返却結果

属性名 型 説明
code 整数型 実行結果コード、1000は成功を表します
items 配列 番号リスト, 詳細はデータ構造-中継番号を参照してください
meta オブジェクト ページネーション情報、詳細は共通データを参照してください
### サンプル 
curl https://demo.udesk.cn/open_api_v1/callcenter/callout_number_list?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "items": [
        {
            "id": 1,
            "number": "01086465044",
            "name": "テストテスト",
            "memo": "備考備考",
            "type": null,
            "province": "北京",
            "supplier": null,
            "pstn": null,
            "call_limit": 10
        },
        {
            "id": 2,
            "number": "66666666",
            "name": "fakenumber",
            "memo": "fake",
            "type": null,
            "province": null,
            "supplier": null,
            "pstn": null,
            "call_limit": 10

        },
        {
            "id": 3,
            "number": "05712620039",
            "name": "udesk番号・",
            "memo": "テスト・",
            "type": null,
            "province": null,
            "supplier": null,
            "pstn": null,
            "call_limit": 10

        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_records": 3
    }
}

エージェントのコールセンター状態を取得

このAPIは、エージェントのコールセンター状態を取得するために使用されます。

リクエストメソッド

GET /callcenter/agent_state

リクエストパラメータ

パラメータ名 必須 タイプ 説明
agent_email はい 文字列 エージェントのメールアドレス

レスポンス結果

属性名 タイプ 説明
code 整数型 実行結果コード、1000は成功を表します
agent_work_state 文字列 エージェントのオンライン状態値の説明
agent_call_state 文字列 エージェントの通話状態値の説明
agent_work_state_des 文字列 エージェントの通話状態の日本語説明
### サンプル 
curl https://demo.udesk.cn/open_api_v1/callcenter/agent_state?agent_email=agent@udesk.cn&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス結果

{
    "agent_work_state": "resting",
    "agent_call_state": "ring",
    "agent_work_state_des": "昼休み",
    "code": 1000
}

エージェントのコールセンター状態を設定

このAPIは、エージェントのコールセンター状態を設定するために使用されます。

リクエストメソッド

POST /callcenter/agent_state

リクエストパラメータ

パラメータ名 必須 タイプ 説明
agent_email はい 文字列 エージェントメールアドレス
agent_work_state はい 文字列 エージェントのオンライン状態値の説明

レスポンス結果

属性名 タイプ 説明
code 整数型 実行結果コード、1000は成功を表します

サンプル

curl https://demo.udesk.cn/open_api_v1/callcenter/agent_state?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
-X POST \
-H 'content-type: application/json' \
-d '{
"agent_email": "agent@udesk.cn",
"agent_work_state": "idle"
}'

レスポンス結果

{
    "code": 1000
}

データ構造-中継番号

属性 説明 サンプル タイプ
id 番号ID 1 整数型
number 番号 '01086465044' 文字列
name 番号名称 'Udesk番号' 文字列
memo 番号備考 'これはテスト番号です' 文字列
type 番号タイプ "udesk" 文字列
province 所在地 "北京" 文字列
supplier サプライヤー "udesk" 文字列
pstn 通信事業者 "cmcc" 文字列
call_limit 同時接続数 100 整数型
### PSTN値の説明
値 日本語名
cmcc 中国移動
unicom 中国聯通
telecom 中国電信

type値の説明

値 日本語名
udesk udesk番号
no_udesk 非udesk番号

agent_work_state値の説明

値 日本語名
offline オフライン
idle 空き状態
busy ビジー
resting 小休憩
neaten 整理中
カスタム小休憩状態コード エージェントがカスタム小休憩の場合に返される小休憩の状態コード

agent_call_state値の説明

値 日本語名
off 通話なし
ring 呼び出し中
in 通話中

codeエラーコード説明

エラーコード message情報 exception:message情報 説明
2009 この会社はコールセンターを開通していません なし この会社はコールセンター業務モジュールを開通していません
5006 現在のコールセンターシステムは中継番号の取得をサポートしていません なし 現在のコールセンターシステムは中継番号の取得をサポートしていません。技術サポートにお問い合わせください
14500 まずコールセンターを開通してください なし この会社はコールセンター業務を開始していません
14501 まずインテリジェントルーティングを開通してください なし この会社はインテリジェントルーティング業務を開始していません
14502 まずWebコールバック機能を開通してください なし この会社はWebコールバック機能を開始していません
14503 発信者番号は空にできません なし 必須パラメータ{from_number}が未入力または空値です
14504 着信者番号は空にできません なし 必須パラメータ{to_number}が未入力または空値です
14505 着信者番号は現在の会社の中継番号ではありません。データを確認してください messageと同じ パラメータ{to_number}が誤っています
22001 無効なメールアドレスが存在します なし 必須パラメータ{agent_email}が未入力または値が誤っています
50046 未知のカスタマーサポート作業状態です（正常な作業状態はoffline, idle, busy, resting, neatenです） なし パラメータ{agent_work_state}の値が有効範囲外です
206201 パラメータpageが無効です なし パラメータ{page}の形式が誤っているか、有効範囲外です
206202 パラメータper_pageが無効です なし パラメータ{per_page}の形式が誤っているか、有効範囲外です
501019 会社のカスタム休憩状態が有効になっていません なし この会社はカスタム休憩状態機能を有効にしていません（パラメータvariablesに関連）

通話記録リストの取得

このインターフェースは、複数の通話記録情報を一度に取得するために使用されます。

リクエストメソッド

GET /callcenter/calllogs

リクエストパラメータ（Query String）

パラメータ名 必須 説明
start_time はい 検索開始時間
end_time いいえ 検索終了時間
customer_phone いいえ 顧客電話番号
page いいえ ページ番号、1から開始、デフォルトは1
page_size いいえ 1ページあたりの件数、デフォルト30、最大100

返却データ

属性名 タイプ 説明
status 整数 実行結果コード、0は成功を表す
message 文字列 実行結果の説明
size 整数 今回の返却数
total 整数 データ総数
total_pages 整数 データ総ページ数
items 配列 通話記録の配列

item 要素のデータ構造

属性名 タイプ 説明
id 整数 一意の識別子
note_id 整数 業務記録ID
call_start_at 日時 通話開始時間
call_type 文字列 通話タイプ(“着信”,“発信”)
call_number 文字列 発信者番号
mobile_area 文字列 番号の地域
trunk_number 文字列 中継番号
user_name 文字列 顧客名
user_id 整数 顧客ID
call_source 文字列 通話元(“エージェント: xx”、“キュー: xx”、“担当者: xx”、“キュー未選択”)
queue_type 文字列 待機状態(“待機成功”、“待機放棄”、“待機タイムアウト”、“オンラインエージェント不在”)
queue_time 整数 待機時間
agent_id 整数 エージェントID
agent_nick_name 文字列 エージェント名
agent_email 文字列 エージェントメールアドレス
device_info 文字列 デバイス状態(“IP電話”、“携帯電話”)
call_result 文字列 通話結果(“顧客未応答”、“顧客応答”、“エージェント未応答”、“エージェント拒否”、“エージェント応答”、“キュー未選択”)
ring_time 整数 呼び出し時間
drop_side 文字列 切断側、“顧客”、“エージェント”
call_time 整数 通話時間
record_url 文字列 録音ファイルのURL
leave_message 文字列 メッセージ
organization_id 文字列 顧客所属会社ID
satisfaction 文字列 満足度評価、“満足”、“不満”、“未評価”または“評価不要” (クイックルーティングのデフォルト満足度評価のみサポート。可能な限りsurveyフィールドを使用してください)
survey 文字列 満足度評価 (新しい満足度評価フィールド。インテリジェントルーティングのカスタム満足度評価をサポートし、クイックルーティングのデフォルト満足度評価とも互換性があります)
ivr_time 整数 IVR時間
has_subsequent_call boolean 後続通話の有無 (true, false, null)
queue_overflow 文字列 オーバーフローキュー
ad_task_name 文字列 自動発信タスク名
ivr_variables 文字列 IVR変数
defeat_cause 文字列 発信失敗理由 (有効化後に表示)
outline_phone_number 文字列 外線番号
multi_ring_count 整数 順次呼び出し回数
tickets 文字列配列 チケット番号
has_subsequent_call boolean 後続通話
outline_phone_number 文字列 外線番号
call_id 文字列 通話一意識別子
### サンプル 
curl https://demo.udesk.cn/open_api_v1/callcenter/calllogs?timestamp=1644891490&sign=872bfa7b074e7cfdafaa75ae10b07aacb6a35123&nonce=c02f0bff-ea00-4d1c-ab0a-7c8bd4a3e456&sign_version=v2&page=1&per_page=20&email=XXXXX@udesk.cn&start_time=2022-02-01&end_time=2022-02-14&customer_phone=15212345678

レスポンス

{
    "code": 1000,
    "message": "成功",
    "items": [
        {
            "id": 70295,
            "note_id": null,
            "call_start_at": "2022-02-07 09:35:42",
            "call_type": "発信",
            "call_number": "15212345678",
            "mobile_area": null,
            "trunk_number": "Cat中継番号 043262201234",
            "user_name": null,
            "user_id": null,
            "call_source": null,
            "queue_type": null,
            "queue_time": null,
            "agent_id": 19,
            "agent_nick_name": "cc-cat",
            "agent_email": "XXX@cat.cn",
            "device_info": "ウェブ電話",
            "call_result": "顧客が応答せず",
            "ring_time": 20,
            "drop_side": "カスタマーサポート",
            "call_time": 0,
            "record_url": null,
            "leave_message": "いいえ",
            "satisfaction": "評価不要",
            "survey": "評価不要",
            "organization_id": null,
            "ivr_time": null,
            "queue_overflow": "オーバーフローなし",
            "ad_task_name": null,
            "ivr_variables": null,
            "defeat_cause": null,
            "tickets": [],
            "multi_ring_count": 0,
            "has_subsequent_call": null,
            "outline_phone_number": null,
            "call_id": "0dde52ed-8261-4b59-9cad-1b3e8591XXXX",
            "dtmf": null,
            "callout_task_id": [],
            "callout_task_name": []
        }
    ],
    "size": 1,
    "total": 1,
    "total_pages": 1
}

通話記録詳細の取得

このインターフェースは、call_idを使用して通話記録の詳細を取得するために使用されます。

リクエストメソッド

GET /callcenter/call_log

リクエストパラメータ（Query String）

パラメータ名 必須 説明
call_id 否 通話記録ID
conversation_id 否 セッションID

call_id と conversation_id の少なくとも一方を入力する必要があり、空であってはなりません。両方入力された場合、conversation_id が優先されます。

このインターフェースの認証方法は、公式サイトの他のOpenAPIと同様です。認証方法を参照してください。

レスポンスデータ

属性名 タイプ 説明
code 整数 実行結果コード、1000は成功を表します
message 文字列 実行結果の説明
call_log 配列 通話記録情報

call_logのデータ構造

属性名 タイプ 説明
id 整数 一意の識別子
note_id 整数 業務記録ID
call_start_at 日時 通話開始時間
call_type 文字列 通話タイプ("着信", "発信")
call_number 文字列 発信者番号
mobile_area 文字列 番号の帰属地
trunk_number 文字列 中継番号
user_name 文字列 顧客名
user_id 整数 顧客ID
call_source 文字列 通話ソース("カスタマーサポート: xx", "キュー: xx", "担当者: xx", "キュー未選択")
queue_type 文字列 待機状態("待機成功", "待機放棄", "待機タイムアウト", "オンラインのカスタマーサポート不在")
queue_time 整数 待機時間
agent_id 整数 カスタマーサポートID
agent_nick_name 文字列 カスタマーサポート名
agent_email 文字列 カスタマーサポートメールアドレス
device_info 文字列 デバイス状態("IP電話", "携帯電話")
call_result 文字列 通話結果("顧客が応答せず", "顧客が応答", "カスタマーサポートが応答せず", "カスタマーサポートが拒否", "カスタマーサポートが応答", "キュー未選択")
ring_time 整数 呼び出し音時間
drop_side 文字列 通話終了側、"顧客"、"カスタマーサポート"
call_time 整数 通話時間
record_url 文字列 録音ファイルのURL
leave_message 文字列 メッセージを残す
organization_id 文字列 顧客の所属会社ID
satisfaction 文字列 満足度評価、"満足"、"不満"、"未評価"または"評価不要" （クイックルーティングのデフォルト満足度評価のみをサポート。可能な限りsurveyフィールドを使用してください）
survey 文字列 満足度評価（新しい満足度評価フィールド。インテリジェントルーティングのカスタム満足度評価をサポートし、クイックルーティングのデフォルト満足度評価とも互換性があります）
ivr_time 整数 IVR時間
has_subsequent_call boolean 後続通話の有無（true, false, null)
queue_overflow 文字列 オーバーフローキュー
ad_task_name 文字列 自動発信タスク名
ivr_variables 文字列 IVR変数
defeat_cause 文字列 発信失敗の原因（有効化後に表示）
outline_phone_number 文字列 外線番号
multi_ring_count 整数 順次呼び出し回数
tickets 文字列配列 チケット番号
has_subsequent_call boolean 後続通話
outline_phone_number 文字列 外線番号
call_id 文字列 通話の一意の識別子
### サンプル 
curl 'http://kunapp.cat.tryudesk.com/open_api_v1/callcenter/call_log?timestamp=1672917025&sign=6f7bb081e31431efd4c7f37a9a7fb33b0fd6b791&nonce=0.80705304386402&sign_version=v2&email=XXXXX@udesk.cn&call_id=c9b00273-f2ec-4718-8d3b-f65f6536d7e6&conversation_id=76688'

レスポンス

{
    "code": 1000,
    "message": "SUCCESS",
    "call_logs": [
        {
            "id": 76688,
            "note_id": null,
            "call_start_at": "2022-11-09 10:17:36",
            "call_type": "着信（三者通話）",
            "call_number": "01056195632",
            "mobile_area": "北京 北京",
            "trunk_number": "Cat中継番号 043262205149",
            "user_name": "ce1ec4b939a54714",
            "user_id": 26865,
            "call_source": "カスタマーサポート：Testerkun",
            "queue_type": null,
            "queue_time": 6,
            "agent_id": 1917,
            "agent_nick_name": "下線1",
            "agent_email": "xiahua_xian@udesk.cn",
            "device_info": "携帯電話",
            "call_result": "カスタマーサポートが応答",
            "ring_time": 7,
            "drop_side": "カスタマーサポート",
            "call_time": 7,
            "record_url": "https://pro-ccrecords.kefutoutiao.com//3c31d817-4d37-46d8-6c09-1be54dda3c03/cc_recordings/20221109101736_c9b00273-f2ec-4718-8d3b-f65f6536d7e6_04295577-94ef-42b6-9f05-49e6fe8247cb.wav?OSSAccessKeyId=bPexlr6MCcadDhfu&Expires=1673003425&Signature=5ZNp5Op8kiInPje8zN%2FEcFjUgRI%3D",
            "leave_message": "いいえ",
            "satisfaction": "未評価",
            "survey": "評価済み；新満足度 -不満足",
            "organization_id": null,
            "ivr_time": 217,
            "queue_overflow": "オーバーフローなし",
            "ad_task_name": null,
            "ivr_variables": "name:私の名前は活動IDが死ぬ第三です,safe:越境ECは何を見ても口座開設手数料ueuueue",
            "defeat_cause": null,
            "tickets": [],
            "multi_ring_count": 0,
            "has_subsequent_call": null,
            "outline_phone_number": null,
            "call_id": "c9b00273-f2ec-4718-8d3b-f65f6536d7e6",
            "dtmf": null,
            "callout_task_id": [],
            "callout_task_name": []
        }
    ]
}