アウトバウンドタスクリストの取得

このAPIは指定された期間のアウトバウンドタスクリストを取得するために使用されます。

リクエストメソッド

GET /callout_tasks

リクエストパラメータ

パラメータ名 必須 説明
start_time はい 開始時間
end_time はい 終了時間

レスポンスデータ

属性名 タイプ 説明
code 整数型 実行結果コード、1000は成功を表します
callout_tasks オブジェクト配列 アウトバウンドタスクリスト情報、タスクID、タスク名、作成時間を含みます

例

curl https://demo.udesk.cn/open_api_v1/callout_tasks?start_time=2017-04-21%2016:34:02&end_time=2018-04-21%2016:34:52&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "callout_tasks": [
        {
            "id": 1,
            "name": "アウトバウンドタスク1",
            "created_at": "2017-10-11T20:35:37.000+08:00"
        },
        {
            "id": 2,
            "name": "アウトバウンドタスク2",
            "created_at": "2017-12-28T11:07:17.000+08:00"
        },
        {
            "id": 3,
            "name": "アウトバウンドタスク3",
            "created_at": "2017-12-29T11:35:37.000+08:00"
        }
    ]
}

アウトバウンドタスク詳細の取得

このAPIは指定されたIDのアウトバウンドタスク情報を取得するために使用されます。

リクエストメソッド

GET /callout_tasks/:id

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

パラメータ名 必須 説明
id はい アウトバウンドタスクID

レスポンスデータ

属性名 タイプ 説明
code 整数型 実行結果コード、1000は成功を表します
callout_task オブジェクト アウトバウンドタスク情報、以下の通り
##### callout_task
属性名 タイプ 説明
id 整数型 一意の識別子
name 文字列 名称
description 文字列 説明
start_at 日時 開始時間
end_at 終了時間 終了時間
created_at 日時 作成時間
status 整数型 ステータス、0は開始、1は一時停止
task_type 整数型 タスクタイプ、固定で0を渡す
agent_type 整数型 オペレータ、0は全オペレータ、1はキュー、2はカスタム
distribution_strategy 整数型 顧客オペレータ割り当て戦略、0（デフォルト）は均等割り当て、1は負荷分散割り当て
queue_ids 配列 キューIDの配列
customers 配列 顧客識別子の配列、識別子はid、token、電話番号、またはメールアドレス、編集と新規作成のみに使用
customer_ids 配列 顧客IDの配列
agent_ids 配列 オペレータIDの配列
customer_count 整数型 顧客数
executed_count 整数型 通話接続数
success_count 整数型 成功数
total_executed_count 整数型 総実行数
total_success_count 整数型 総通話接続数
questionnaire_id 整数型 アウトバウンドタスクに紐づくアンケートテンプレートID
callout_note_template_id 整数型 アウトバウンドタスクに関連するアウトバウンド業務情報テンプレートID
### サンプル 
curl https://demo.udesk.cn/open_api_v1/callout_tasks/1?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "callout_task": {
        "id": 1,
        "name": "CallOutTask",
        "status": 0,
        "description": "テスト",
        "created_at": "2017-03-14T14:12:42.000+08:00",
        "customer_ids": [1, 2, 3, 4],
        "agent_ids": [1, 2],
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "task_type": 0,
        "agent_type": 0,
        "queue_ids": null,
        "customer_count": 4,
        "executed_count": 0,
        "success_count": 0,
        "total_executed_count": 0,
        "total_success_count": 0,
        "callout_note_template_id": 1
    }
}

アウトバウンドタスクの作成

このAPIはアウトバウンドタスクの作成に使用されます。

リクエストメソッド

POST /callout_tasks

リクエストパラメータ（Request Body）

パラメータ名 タイプ 必須 説明
callout_task オブジェクト はい アウトバウンドタスク情報、以下を参照
callout_task
属性名 タイプ 新規作成時必須 説明
name 文字列 はい 名称
description 文字列 説明
start_at 日時 はい 開始時間
end_at 日時 はい 終了時間
status 整数 はい ステータス、0は有効、1は一時停止
task_type 整数 はい タスクタイプ、固定値0を渡す
agent_type 整数 はい オペレータ、0は全オペレータ、1はキュー、2はカスタム
distribution_strategy 整数 顧客オペレータ割り当て戦略、0（デフォルト）は均等割り当て、1は負荷分散割り当て
queue_ids 配列 キューID配列
customers 配列 顧客識別子配列、識別子は id、token、電話番号またはメールアドレス、編集と新規作成のみに使用
customer_ids 配列 はい 顧客ID配列
agent_ids 配列 オペレータID配列
questionnaire_id 整数 アウトバウンドタスクに紐づくアンケートテンプレートID
callout_note_template_id 整数 アウトバウンドタスクに関連付けるアウトバウンド業務情報テンプレートID
hide_number 整数 電話番号マスキング (0：いいえ，1：はい，デフォルト0)
is_repeat_customer_task 整数 アウトバウンドタスクの顧客重複を許可するか (0：いいえ，1：はい，デフォルト0)
distribution_basis 整数 顧客割り当ての基準 (0：タスク顧客ID，1：顧客ID，デフォルト0)
### 返却データ

発信タスク詳細取得インターフェースと同じです。

例

curl https://demo.udesk.cn/open_api_v1/callout_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 '
{
    "callout_task": {
        "name": "CallOutTask",
        "description": "テスト",
        "agent_type": 0,
        "agent_ids": [1, 2],
        "task_type": 0,
        "status": 0,
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "questionnaire_id": 12,
        "callout_note_template_id": 1,
        "hide_number": 1,
        "is_repeat_customer_task": 1,
        "distribution_basis": 1,
        "customers": [
            {"type":"token", "content":"123456", "callout_note_custom_fields": {"SelectField_1" : ["0", "0", "0", "0", "0", "0", "0"], "TextField_4" : "2019-11-13"}},
            {"type":"id","content":107387, "callout_note_custom_fields": {"TextField_5" : "11:04:35", "TextField_6" : "発信業務記録", "SelectField_8" : ["0"]}},
            {"type":"email","content":"wxb1@qq.com"},
            {"type":"cellphone","content":"13500010846","batch_number":"myBatch123"}
        ]
    }
}'

返却

{
    "code": 1000,
    "callout_task": {
        "id": 1,
        "name": "CallOutTask",
        "status": 0,
        "description": "テスト",
        "created_at": "2017-03-14T14:12:42.000+08:00",
        "customer_ids": [1, 2, 3, 4],
        "agent_ids": [1, 2],
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "task_type": 0,
        "agent_type": 0,
        "queue_ids": null,
        "customer_count": 4,
        "executed_count": 0,
        "success_count": 0,
        "total_executed_count": 0,
        "total_success_count": 0,
        "questionnaire_id": 12,
        "callout_note_template_id": 1,
        "hide_number": 1,
        "is_repeat_customer_task": 1,
        "distribution_basis": 1
    }
}

外呼タスクの更新

このインターフェースは、作成した外呼タスクを修正するために使用されます。

リクエストメソッド

PUT /callout_tasks/:id

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

パラメータ名 必須 説明
id はい 外呼タスクID

リクエストパラメータ（Request Body）

パラメータ名 タイプ 必須 説明
callout_task オブジェクト はい 外呼タスク情報、以下を参照
callout_task
属性名 タイプ 編集可能 必須 説明
name 文字列 はい はい 名称
description 文字列 はい 説明
start_at 日時 はい はい 開始時間
end_at 日時 はい はい 終了時間
status 整数 はい はい ステータス、0は有効、1は一時停止
task_type 整数 はい はい タスクタイプ、固定値0を渡します
agent_type 整数 はい（新規作成時） はい オペレータ、0は全オペレータ、1はキュー、2はカスタム
distribution_strategy 整数 はい 顧客-オペレータ割り当て戦略、0（デフォルト）は均等割り当て、1は負荷分散割り当て
queue_ids 配列 はい（新規作成時） キューIDの配列
customers 配列 はい 顧客識別子の配列、識別子は id、token、電話番号、またはメールアドレスです。編集および新規作成時にのみ使用されます
customer_ids 配列 顧客IDの配列
distribution_basis 整数 はい 顧客割り当ての基準 (0：タスク顧客ID、1：顧客ID、デフォルト0)
### 返却データ

発信タスク詳細取得インターフェースと同じです。

備考

手動発信タスクを作成または更新する際、開始時刻と終了時刻が同じ日にある場合の問題を避けるため、インターフェースで渡された終了時刻に1日を加え、さらに1分を引いた後、この手動発信タスクの終了時刻として保存されます。つまり、手動発信タスクの最短実行時間は23時間59分です。

例

curl https://demo.udesk.cn/open_api_v1/callout_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 '
{
    "callout_task": {
        "name": "CallOutTask",
        "description": "テスト",
        "agent_type": 0,
        "agent_ids": [1, 2],
        "task_type": 0,
        "status": 0,
        "distribution_basis": 0,
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "customers": [
            {"type":"token", "content":"123456"},
            {"type":"id","content":107387", "callout_note_custom_fields": {"TextField_5" : "11:04:35", "TextField_6" : "発信業務記録", "SelectField_8" : ["0"], "SelectField_9" : "0,5,8"}},
            {"type":"email","content":"wxb1@qq.com"},
            {"type":"cellphone","content":"13500010846"}
        ]
    }
}'

返却

{
    "code": 1000,
    "callout_task": {
        "id": 1,
        "name": "CallOutTask",
        "status": 0,
        "description": "テスト",
        "created_at": "2017-03-14T14:12:42.000+08:00",
        "customer_ids": [1, 2, 3, 4],
        "agent_ids": [1, 2],
        "start_at": "2015-01-01T00:00:00.000+08:00",
        "end_at": "2015-01-01T23:59:00.000+08:00",
        "task_type": 0,
        "agent_type": 0,
        "queue_ids": null,
        "customer_count": 4,
        "executed_count": 0,
        "success_count": 0,
        "total_executed_count": 0,
        "total_success_count": 0,
        "questionnaire_id": 12,
        "callout_note_template_id": 1,
        "hide_number": 1,
        "is_repeat_customer_task": 1,
        "distribution_basis": 1
    }
}

外呼タスクの削除

このインターフェースは、指定されたIDの外呼タスクを削除するために使用されます。

リクエストメソッド

DELETE /callout_tasks/:id

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

パラメータ名 必須 説明
id はい 外呼タスクID

レスポンスデータ

属性名 型 説明
code 整数型 実行結果コード、1000は成功を表します
id 整数型 削除された外呼タスクID

例

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

レスポンス

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

外呼タスクの顧客リストの取得

このインターフェースは、指定されたIDの外呼タスクの顧客情報を取得するために使用されます。

リクエストメソッド

GET /callout_tasks/customers

リクエストパラメータ（クエリストリング）

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

レスポンスデータ

属性名 型 説明
code 整数型 実行結果コード、1000は成功を表します
meta オブジェクト ページネーション情報、詳細は共通データを参照してください
customers 配列 顧客リスト

customers要素のデータ構造

属性名 型 説明
task_id 整数型 外呼タスク内のサブタスクID
id 整数型 顧客ID
nick_name 文字列 顧客名
cellphones 配列 顧客の携帯電話番号リスト
agent_id 整数型 エージェントID
call_count 整数型 通話回数
result 文字列 通話結果

cellphones要素の構造

属性名 型 説明
id 整数型 一意の識別子
content 文字列 電話番号
### サンプル 
curl https://demo.udesk.cn/open_api_v1/callout_tasks/customers?id=1&page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "customers": [
        {
            "task_id": 1,
            "id": 1,
            "nick_name": "テスト顧客",
            "cellphones": [
                {
                    "id": 1,
                    "content": "13000000001"
                }
            ],
            "agent_id": 1,
            "call_count": 0,
            "result": null
        },
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    }
}

アウトバウンドタスクのエージェントリストを取得

このAPIは、指定されたIDのアウトバウンドタスクのエージェント情報を取得するために使用されます。

リクエストメソッド

GET /callout_tasks/agents

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

パラメータ名 必須 説明
id はい アウトバウンドタスクID
page いいえ ページ番号、1から開始、デフォルトは1
per_page いいえ 1ページあたりの件数、デフォルト10、最大100

レスポンスデータ

属性名 型 説明
code 整数型 実行結果コード、1000は成功を表します
meta オブジェクト ページネーション情報、詳細は共通データを参照
agents 配列 エージェントリスト

agents要素のデータ構造

属性名 型 説明
id 整数型 エージェントID
name 文字列 エージェント名
customer_count 整数型 顧客数
executed_count 整数型 実行数
total_success_count 整数型 成功数
total_executed_count 整数型 総実行数
### サンプル 
curl https://demo.udesk.cn/open_api_v1/callout_tasks/agents?id=1&page=1&per_page=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "agents": [
        {
            "id": 1,
            "name": "テストエージェント",
            "customer_count": 1,
            "executed_count": 0,
            "success_count": 0,
            "total_executed_count": 0,
            "total_success_count": 0
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    }
}

番号を削除する

このAPIは、指定されたアウトバウンドタスクの番号を削除するために使用されます。

リクエストメソッド

DELETE /callout_tasks/:id/delete_number

リクエストパラメータ

パラメータ名 必須 説明
number はい 電話番号

レスポンスデータ

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

サンプル

curl -X DELETE \
  https://demo.udesk.cn/open_api_v1/callout_tasks/1/delete_number?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' \
  -d '{
  "number": "18710846413"
}'

レスポンス結果

{
  "code": 1000
}

番号を再割り当てする

このAPIは、番号を再割り当てするために使用されます。

リクエストメソッド

POST /callout_tasks/:id/redistribution

リクエストパラメータ

パラメータ名 必須 説明
number はい 電話番号
agent_id はい エージェントID

レスポンスデータ

属性名 型 説明
code 整数型 実行結果コード、1000は成功を表します
### サンプル 
curl -X POST \
  https://demo.udesk.cn/open_api_v1/callout_tasks/1/redistribution?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' \
  -d '{
  "number": "18710846413",
  "agent_id": 1
}'

レスポンス

{
  "code": 1000
}

データ構造-アウトバウンドタスク

属性名 タイプ 編集可能 必須 説明
id 整数 一意の識別子
name 文字列 はい はい 名称
description 文字列 はい 説明
start_at 日時 はい はい 開始時間
end_at 日時 はい はい 終了時間
created_at 日時 作成時間
status 整数 はい はい ステータス、0は有効、1は一時停止
task_type 整数 はい はい タスクタイプ、固定値0を渡す
agent_type 整数 はい（新規） はい エージェントタイプ、0は全エージェント、1はキュー、2はカスタム
distribution_strategy 整数 はい 顧客-エージェント割り当て戦略、0（デフォルト）均等割り当て、1は負荷分散割り当て
queue_ids 配列 はい（新規） キューIDの配列
customers 配列 はい 顧客識別子の配列、識別子はid、token、電話番号、メールアドレス。編集と新規作成のみで使用
customer_ids 配列 はい 顧客IDの配列
agent_ids 配列 はい（新規） エージェントIDの配列
customer_count 整数 顧客数
executed_count 整数 実行数（通話接続数）
success_count 整数 成功数
total_executed_count 整数 総実行数
total_success_count 整数 総成功数
questionnaire_id 整数 はい（新規） アウトバウンドタスクに紐づくアンケートテンプレートID
callout_note_template_id 整数 はい（新規） アウトバウンドタスクに関連付けるアウトバウンド業務情報テンプレートID
### customers要素の構造
属性名 タイプ 説明
type 文字列 検索条件タイプ、"id"、"token"、"email"、"cellphone"のいずれか
content 文字列 検索条件の内容

アウトバウンド業務情報テンプレートリストの取得

このAPIは、アウトバウンド業務情報テンプレートのリストを取得するために使用されます。

リクエストメソッド

GET /callout_note_templates

リクエストパラメータ

なし

レスポンスデータ

属性名 タイプ 説明
code 整数型 実行結果コード、1000は成功を表します
callout_note_templates オブジェクト配列 アウトバウンド業務情報テンプレートリスト情報、テンプレートID、テンプレート名を含む

例

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

レスポンス

{
  "code": 1000,
  "callout_note_templates": [{
      "id": 4,
      "name": "新しいアウトバウンド業務情報テンプレートのテスト"
    },

    {
      "id": 55,
      "name": "アウトバウンドタスク専用"
    }
  ]
}

アウトバウンド業務情報テンプレート詳細の取得

このAPIは、指定されたIDのアウトバウンド業務情報テンプレート情報を取得するために使用されます。

リクエストメソッド

GET /callout_note_templates/:id

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

パラメータ名 必須 説明
id はい アウトバウンド業務情報テンプレートID

レスポンスデータ

属性名 タイプ 説明
code 整数型 実行結果コード、1000は成功を表します
callout_note_template オブジェクト アウトバウンド業務情報テンプレート情報、以下のデータ構造を参照
### データ構造-アウトバウンド業務情報テンプレート
属性名 型 説明
id 整数型 一意の識別子
name 文字列 名称
desc 文字列 説明
fields オブジェクト配列 カスタムフィールド、構造は Udeskカスタムフィールド を参照

例

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

レスポンス

{
  "code": 1000,
  "callout_note_template": {
    "id": 4,
    "name": "新しいアウトバウンド業務情報テンプレートのテスト",
    "desc": "これは新しいテストで、作成、読み取り、更新、削除を行います",
    "fields": [{
        "field_name": "TextField_20",
        "field_label": "説明",
        "content_type": "text",
        "comment": null,
        "options": null
      },
      {
        "field_name": "TextField_21",
        "field_label": "拡張内容",
        "content_type": "text",
        "comment": null,
        "options": null
      },
      {
        "field_name": "TextField_23",
        "field_label": "日時",
        "content_type": "date",
        "comment": "日時",
        "options": null
      }
    ]
  }
}

コードエラーコード説明

エラーコード message情報 exception:message情報 説明
2000 不明なエラー 開始時間は必須です 必須パラメータ{start_at}が未入力です
終了時間は必須です 必須パラメータ{end_at}が未入力です
オペレーターIDは必須です 必須パラメータ{agent_ids}が未入力です
無効なオペレータータイプ パラメータ{agent_type}の値が範囲外です
不正なオペレーターID パラメータ{agent_ids}の形式が誤っています
解析できない顧客ID パラメータ{customer_ids}の形式が誤っています
無効なステータスタイプ パラメータ{status}の値が範囲外です
名称は必須です 必須パラメータ{name}が未入力です
無効なタスクタイプ パラメータ{task_type}の値が0ではありません
キューIDは必須です 必須パラメータ{queue_ids}が未入力です
不正なキュー パラメータ{queue_ids}の形式が誤っています
開始時間/終了時間の形式が不正です パラメータ{start_at}または{end_at}の形式が誤っています
開始時間は終了時間より前である必要があります パラメータ{start_at}の値が{end_at}より大きいです
アンケートテンプレートが存在しません 必須パラメータ{questionnaire_id}が未入力です
アンケートテンプレートのステータスが「閉じる」であり、使用できません パラメータ{questionnaire_id}に対応するアンケートテンプレートのステータスが「閉じる」です
アウトバウンド業務情報テンプレートが存在しません 必須パラメータ{callout_note_template_id}が未入力です
param is missing or the value is empty: callout_task 必須パラメータ{callout_task}が未入力または値が空です
2005 該当リソースが見つかりませんでした Couldn't find CalloutTask without an ID パラメータ{id}の値が誤っており、データに一致しません
20282 このテンプレートは削除されました なし パラメータ{id}がデータに一致しません
50048 タスク内に該当顧客が存在しません なし パラメータ{agent_id}に対応するオペレーターがこのアウトバウンドタスクに存在しません
50049 オペレーターIDは必須、または不正です なし 必須パラメータ{agent_id}が未入力または形式が誤っています
501032 番号が不正です なし パラメータ{number}の形式が誤っています。このパラメータの型は文字列です