自動発信タスクの作成

このインターフェースは、自動発信タスクを作成するために使用されます。

リクエストメソッド

POST /cc_ad_tasks

リクエストパラメータ

パラメータ名 タイプ 必須 説明
name 文字列 はい 発信タスク名
description 文字列 いいえ 発信タスクの説明
task_type 整数 はい 発信タスクのタイプ。詳細はタスクタイプの説明を参照してください
user_group_id 整数 はい 発信タスクのカスタマーサポートグループID
force_policy_id 整数 いいえ ルーティングポリシーID。この通話に使用するインテリジェントルーティングを決定します。デフォルトルート
priority 整数 いいえ 優先度 (1-100) デフォルト10
working_time_id 整数 いいえ タスク実行時間帯の勤務時間ID
recall_policy 文字列 いいえ 再発信を開始する通話結果のタイプリスト。詳細はデータ構造-通話結果タイプリストを参照してください
recall_count 整数 いいえ 再発信回数 デフォルト0
recall_interval 文字列 いいえ 再発信間隔 フォーマット "1,2,3" 1回目60秒 2回目120秒 3回目180秒 デフォルト600秒
follow_on_policy 文字列 いいえ 継続発信を開始する通話結果タイプ。詳細はデータ構造-通話結果タイプリストを参照してください
callout_number 文字列 いいえ 中継番号（発信者番号表示）
call_limit 文字列 いいえ タスクの同時実行数。callout_numberで指定されたタスク同時実行数を超える値は設定できません

レスポンス結果

属性名 タイプ 説明
code 整数 実行結果コード。1000は成功を表します
id 整数 発信タスクID

例

curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks?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 '
{
    "name": "発信タスク",
    "description": "これは発信タスクです",
    "task_type": 1,
    "user_group_id": 100,
    "force_policy_id": 1,
    "priority": 10,
    "working_time_id": 1,
    "recall_policy": "customer_missed",
    "recall_count": 6,
    "recall_interval": "1,2,3,4,5,6",
    "follow_on_policy": "customer_missed",
    "callout_number": "021002002020",
    "call_limit": "10"

}'

レスポンス

{
  "code": 1000,
  "id": 1
}

自動発信タスクの更新

このインターフェースは、自動発信タスクの名前と説明を更新するために使用されます。

リクエストメソッド

PUT /cc_ad_tasks/:id

リクエストパラメータ

パラメータ名 必須 説明
name はい 発信タスク名
description いいえ 発信タスクの説明
callout_number いいえ 中継番号（発信者番号）
call_limit いいえ タスクの同時実行数

返却結果

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

例

curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/1?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
-X PUT \
-H 'content-type: application/json' \
-d '
{
    "name": "発信タスク修正",
    "description": "これは修正する発信タスクです",
    "callout_number": "021002002020",
    "call_limit": "10"

}'

返却

{
  "code": 1000,
}

自動発信タスクリストの取得

このインターフェースは、自動発信タスクのリストを取得するために使用されます。

リクエストメソッド

GET /cc_ad_tasks

リクエストパラメータ

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

返却結果

属性名 型 説明
code 整数型 実行結果コード、1000は成功を表します
cc_ad_tasks 配列 発信タスク情報、データ構造-自動発信タスクを参照
meta オブジェクト ページネーション情報、詳細は共通データを参照
### サンプル 
curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks?page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
  "code": "1000",
  "cc_ad_tasks": [
  {
    "id": 1,
    "name": "自動発信",
    "description": "自動発信タスクの説明",
    "task_type": 2,
    "user_group_id": 100,
    "customer_count": 100000,
    "callout_number": "057126200039",
    "created_at": "2017-10-21 11:22:33",
    "status": 1,
    "execute_customer_count": 100000,
    "customer_answer_count": 100000,
    "agent_answer_count": 100000,
    "call_success_rate": "1.0",
    "agent_answer_rate": "1.0",
    "agent_use_rate": "1.0",
    "disturb_rate": "0.0",
    "minute_call_rate": "1.0",
    "minute_agent_use_rate": "1.0",
    "minute_disturb_rate": "0.0"
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages":1,
    "total_entries": 1
    }
}

自動発信タスク詳細の取得

このAPIは単一の発信タスクの詳細を照会するために使用されます。

リクエストメソッド

GET /cc_ad_tasks/:id

リクエストパラメータ

なし

レスポンス結果

属性名 型 説明
code 整数 実行結果コード、1000は成功を表します
item オブジェクト 発信タスク情報、データ構造-自動発信タスク詳細を参照してください

サンプル

curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/1?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "item": {
        "id": 16,
        "name": "発信待機",
        "status": 2,
        "call_limit": 10,
        "callout_number": "05712620039",
        "task_type": 1,
        "force_policy_id": 45,
        "user_group_id": 323,
        "description": null,
        "created_at": "2017-11-02T20:13:40.000+08:00",
        "schedule_id": null,
        "redial_times": 0,
        "redial_guide": ["1", "1"],
        "redial_scene": ["phone_busy", "phone_outline"],
        "redial_multi_scene": ["phone_busy"],
        "priority": 10,
        "force_policy_name": "自動発信",
        "schedule_name": null,
        "customer_count": 2,
        "execute_customer_count": 6,
        "customer_answer_count": 0,
        "agent_answer_count": 0,
        "call_success_rate": "0.0",
        "agent_answer_rate": "0",
        "agent_use_rate": "0.0",
        "disturb_rate": "0",
        "minute_call_rate": "1.0",
        "minute_agent_use_rate": "0.0",
        "minute_disturb_rate": "0.0"
    }
}

自動発信タスクへの番号インポート

このAPIは、指定された自動発信タスクに番号を追加するために使用されます。1回のリクエストで最大300件までインポートでき、呼び出し頻度は1回/秒を超えてはいけません。

リクエストメソッド

POST /cc_ad_tasks/add_numbers

Content Type

application/json

リクエストパラメータ

パラメータ名 必須 型 説明
id はい 整数型 自動発信タスクID
numbers はい 配列 追加する番号の配列。詳細はデータ構造-自動発信番号インポート構造を参照してください

レスポンス結果

属性名 型 説明
code 整数型 実行結果コード。1000は成功を表します
successful_count 整数型 インポートに成功した番号の数
unsuccessful_count 整数型 インポートに失敗した番号の数
unsuccessful_numbers 配列 インポートに失敗した番号のリスト。構造の詳細はデータ構造-インポート失敗番号構造を参照してください

例

curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/add_numbers?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 '
{
  "id": 1,
  "numbers": [
    {"cellphone": "13223004567", "name": "テスト番号1", "description": "番号説明情報1"},
    {"cellphone": "13223004568", "name": "テスト番号2", "description": "番号説明情報2"},
    {"cellphone": "13223004569", "name": "テスト番号3", "description": "番号説明情報3",
     "custom": {"会社": "Udesk", "住所": "北京市"}
    }
  ]
}'

3件のレコードがすべてインポートに成功した場合、以下のように返されます。

{
  "code": 1000,
  "successful_count": 3,
  "unsuccessful_count": 0,
  "unsuccessful_numbers": []
}

注意事項

自動発信タスクの番号プールを取得

このAPIは、指定された自動発信タスクの番号プールリストを返します。1回のリクエストで最大500件のレコードを返します。

リクエストメソッド

GET /cc_ad_tasks/numbers

リクエストパラメータ

パラメータ名 必須 タイプ 説明
id はい 整数型 自動発信タスクID
start_number_id いいえ 整数型 開始する番号プール番号ID、デフォルトは0です。注：番号IDがこの値より大きい番号プールのみを返します

レスポンス結果

属性名 タイプ 説明
code 整数型 実行結果コード、1000は成功を表します
numbers 配列 返される番号リストの詳細、構造はデータ構造-番号プール構造を参照してください
meta オブジェクト 追加情報、構造はデータ構造-番号プール追加情報を参照してください

例

curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/numbers?id=12292&start_number_id=2&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
  "code": 1000,
  "numbers": [
    {
      "id": 3,
      "name": "テスト番号3",
      "cellphone": "13989001200",
      "description": "番号3の説明",
      "call_count": 0,
      "customer_answer_count": 0,
      "agent_answer_count": 0
    },
    {
      "id": 14,
      "name": "テスト番号14",
      "cellphone": "13989001201",
      "description": "番号14の説明",
      "call_count": 0,
      "customer_answer_count": 0,
      "agent_answer_count": 0
    }
  ],
  "meta": {
    "record_size": 2,
    "max_number_id": 14
  }
}

自動発信タスク番号再発信

リクエストメソッド

POST /cc_ad_tasks/recall

リクエストパラメータ

パラメータ名 必須 タイプ 説明
id はい 整数型 発信タスクID
number はい 文字列 再発信する電話番号
after_at はい 文字列 再発信の開始時間 形式 YYYY-MM-DDTHH:MM:SSZ

戻り結果

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

例

curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/recall?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 '
{
  "id":1,
  "number":"13412341234",
  "after_at":"2019-02-08T15:30:02+08:00"
}'

戻り値

{
  "code": 1000,
  "message": "再呼び出し成功"
}

自動発信タスク番号継続発信

リクエスト方法

POST /cc_ad_tasks/follow_on

リクエストパラメータ

パラメータ名 必須 タイプ 説明
id はい 整数型 発信タスクID
called はい 文字列 既に発信した電話番号

戻り結果

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

例

curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/follow_on?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 '
{
    "id": 1,
    "called": "13223004570"
}'

戻り値

{
  "code": 1000,
  "message": "継続発信成功"
}

自動発信タスクの開始/停止

リクエストメソッド

POST /cc_ad_tasks/:id/open

リクエストパラメータ

パラメータ名 必須 タイプ 説明
open はい ブール型 true/false
callout_number いいえ 文字列 中継番号

レスポンス結果

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

例

curl https://demo.udesk.cn/open_api_v1/cc_ad_tasks/1/open?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 '
{
    "open": true/false,
    "callout_number": "01086465047"
}'

レスポンス

{
  "code": 1000
}

データ構造-自動発信タスク

属性 説明 例 タイプ
id タスクID 1 整数型
name タスク名 '自動発信' 文字列
description タスク説明 'これは自動発信タスクです' 文字列
task_type タスクタイプ 1 整数型
callout_number 発信番号 "01086465047" 文字列
user_group_id オペレータグループID 100 整数型
customer_count 顧客数 100000 整数型
created_at 作成日時 '2017-11-22 10:32:33' 日時
status ステータス 1 整数型
execute_customer_count 実行数 100000 整数型
customer_answer_count 顧客応答数 100000 整数型
agent_answer_count オペレータ応答数 100000 整数型
call_success_rate 発信成功率 '0.67' 文字列
agent_answer_rate オペレータ応答率 '0.32' 文字列
disturb_rate 迷惑率 '0.0' 文字列
agent_use_rate オペレータ使用率 '1.0' 文字列
minute_call_rate 10分間応答率 '1.0' 文字列
minute_agent_use_rate 10分間迷惑率 '1.0' 文字列
minute_disturb_rate 10分間オペレータ使用率 '1.0' 文字列
### タスクタイプ説明(task_type)
値 日本語名
1 精密発信
2 比例発信
3 予測発信
4 シンプルIVR(音声案内、キュー非投入)

状態説明(status)

値 日本語名
1 有効
2 無効
3 停止中

データ構造-自動発信番号インポートの構造

属性 型 説明 必須
cellphone 文字列 電話番号,複数番号はカンマ区切りで対応 はい
name 文字列 氏名 いいえ
description 文字列 説明 いいえ
custom オブジェクト カスタムデータ,構造はデータ構造-インポート自動発信番号のカスタムデータを参照 いいえ

データ構造-インポート失敗番号の構造

属性 型 説明
cellphone 文字列 電話番号
name 文字列 氏名
description 文字列 説明
custom オブジェクト カスタムデータ
reason 文字列 失敗理由

データ構造-番号プールの構造

属性 型 説明
id 整数 番号ID
name 文字列 氏名
cellphone 文字列 電話番号
description 文字列 説明
call_count 整数 発信回数
customer_answer_count 整数 顧客応答回数
agent_answer_count 整数 オペレーター応答回数

データ構造-番号プール追加情報

属性 型 説明
record_size 整数 今回のリクエストで返却された番号数
max_number_id 整数 今回のリクエストで返却された最大番号ID(record_sizeが0の場合、この値はnull)、次回リクエストのstart_number_idとして使用可能
## データ構造-自動発信番号インポートのカスタムデータ

カスタムフィールドの数は10個を超えてはいけません

属性 型 説明 必須
フィールド1 文字列 フィールド名はカスタマイズ可能 はい
フィールド2 文字列 フィールド名はカスタマイズ可能 いいえ
フィールド3 文字列 フィールド名はカスタマイズ可能 いいえ
.... 文字列 フィールド名はカスタマイズ可能 いいえ
フィールド10 文字列 フィールド名はカスタマイズ可能 いいえ

データ構造-通話結果タイプリスト

値 日本語名
customer_missed 顧客不在
agent_missed オペレーター不在
customer_breakout 顧客即時切れ
phone_outline 電話機オフライン
phone_busy 電話機ビジー

データ構造-自動発信タスク詳細

属性 説明 例 型
id タスクID 1 整数型
name タスク名 '自動発信' 文字列
status ステータス 1 整数型
call_limit 同時接続制限 1 整数型
callout_number 発信番号 "01086465047" 文字列
task_type タスクタイプ 1 整数型
force_policy_id ルーティングポリシーID 1 整数型
user_group_id オペレーターグループID 100 整数型
description タスク説明 'これは自動発信タスクです' 文字列
created_at 作成時間 '2017-11-22 10:32:33' 日時型
schedule_id 勤務時間ID 1 整数型
redial_times 再発信回数 0 整数型
redial_guide 再発信間隔 ["1", "1"] 配列
redial_scene 再発信ポリシー ["phone_busy", "phone_outline"] 配列
redial_multi_scene 継続発信ポリシー ["phone_busy"] 配列
priority 優先度 10 整数型
force_policy_name ルーティングポリシー名 "自動発信" 文字列
schedule_name 勤務時間名 "勤務時間" 文字列
customer_count 顧客数 100000 整数型
execute_customer_count 実行数 100000 整数型
customer_answer_count 顧客応答数 100000 整数型
agent_answer_count オペレーター応答数 100000 整数型
call_success_rate 発信成功率 '0.67' 文字列
agent_answer_rate オペレーター応答率 '0.32' 文字列
disturb_rate 迷惑率 '0.0' 文字列
agent_use_rate オペレーター使用率 '1.0' 文字列
minute_call_rate 10分間接続率 '1.0' 文字列
minute_agent_use_rate 10分間迷惑率 '1.0' 文字列
minute_disturb_rate 10分間オペレーター使用率 '1.0' 文字列

コードエラーコード説明

エラーコード message情報 exception:message情報 説明
2000 不明なエラー unknown attribute: working_time_id パラメータ{working_time_id}の値が空です
undefined method `size' for nil:NilClass 必填参数{numbers}未导入或为空值
2005 没有找到该资源 Couldn't find CcAdTask with id=12 [WHERE cc_ad_tasks.company_id = ?] パラメータ{id}が誤っており、値に一致しません
Couldn't find CcAdTask without an ID パラメータ{id}が誤っており、値に一致しません
206203 パラメータtask_typeが不正です 略 必須パラメータ{task_type}が未入力、または値が許容範囲外です
206204 パラメータuser_group_idが不正です 略 必須パラメータ{user_group_id}が未入力、または値が許容範囲外です
206205 パラメータnameが不正です 略 必須パラメータ{name}が未入力、または値が許容範囲外です
206206 パラメータforce_policy_idが不正です 略 パラメータ{force_policy_id}の値が許容範囲外です
206207 パラメータworking_time_idが不正です 略 パラメータ{force_policy_id}の値が許容範囲外です
501004 起動中の発信タスクには、番号をインポートできません 略 この自動発信タスクは起動状態にあります
501015 パラメータopenは空にできず、true/falseでなければなりません 略 パラメータ{open}の値が許容範囲内のtrueまたはfalseではありません
501016 このタスクは閉鎖中です。重複して閉鎖する必要はありません 略 この自動発信タスクは既に閉鎖状態にあります
501032 番号が不正です 略 必須パラメータ{number}が未入力、または値が許容範囲外です
501033 再発信開始時間の形式が正しくありません 略 必須パラメータ{after_at}が未入力、または形式が誤っています
501035 自動発信タスクは起動中です。重複して起動する必要はありません 略 この自動発信タスクは既に起動状態にあります
503001 現在の会社の有効な中継番号ではありません 略 パラメータ{callout_number}の値が誤っており、許容範囲内にありません
503002 現在の発信表示番号の同時接続制限数に適合しません 略 パラメータ{call_limit}の値が、パラメータ{callout_number}に対応する中継番号の同時接続上限を超えています