※注意：API呼び出し時にはsubdomainパラメータを追加する必要があります

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

このAPIは、会社のすべての手動アウトバウンドタスクのリストを取得するために使用されます。

リクエストメソッド

GET /open_api_v1/outbound_task

リクエストパラメータ

パラメータ名	必須	説明
pageNum	否	ページ番号、デフォルトは1ページ目
pageSize	否	ページあたりのサイズ、デフォルトは100

レスポンスデータ

属性名	タイプ	説明
succeed	ブール型	実行が成功したかどうか
message	実行結果の説明	実行成功時はOK、その他の場合は対応する例外情報を返します
paging	オブジェクト	ページング情報
data	オブジェクト配列	アウトバウンドタスクリスト情報（タスクID、タスク名、作成時間）

例

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

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 100,
        "total": 100
    },
    "data": [
        {
            "id": 271,
            "name": "アウトバウンドタスク1",
            "createdAt": "2020-07-07T16:53:45.000+08:00"
        },
        {
            "id": 272,
            "name": "顧客とアウトバウンド業務フィールドのマッピング",
            "createdAt": "2020-07-07T16:57:28.000+08:00"
        }
    ]
}

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

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

リクエストメソッド

GET /open_api_v1/outbound_task/{id}

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

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

属性名	タイプ	説明
succeed	ブール型	実行が成功したかどうか
message	文字列型	実行成功時はOK、それ以外の場合は対応する例外情報を返す
data	オブジェクト型	アウトバウンドタスクの詳細情報

data

属性名	タイプ	説明
id	整数型	一意の識別子
name	文字列	名称
description	文字列	説明
startAt	日時	タスク開始時間
endAt	終了時間	タスク終了時間
createdAt	日時	作成時間
status	文字列	状態。not_startは未開始、processingは進行中、expiredは期限切れ、pauseは一時停止
importMethod	文字列	インポート戦略-インポート方法。openはカスタマーセンターへインポート、closeはカスタマーセンターへインポートしない
holdImportRepeat	文字列	インポート戦略。updateはインポートフォームの重複部分を更新、not_updateはインポートフォームの重複部分をインポートしない
distributionStrategy	文字列	顧客とオペレーターの割り当て戦略。averageは均等割り当て（デフォルト）、balanceは負荷分散割り当て、manualは手動割り当て
hideNumber	ブール値	マスキングするかどうか。trueはマスキング、falseはマスキングしない（デフォルト）
taskFilter	オブジェクト	アウトバウンドタスクフィルター。以下を参照
agentIds	配列	カスタマーサポートIDの配列
customerCount	整数型	顧客数
executedCount	整数型	タスク実行数。各連絡票の顧客は1回のみカウント
connectedCount	整数型	タスク接続数。各連絡票の顧客は1回のみカウント
sucRate	浮動小数点型	実行成功率
numberFilterStrategy	文字列	番号戦略-フィルター設定。デフォルトはrepeatNumber
questionnaireId	整数型	アウトバウンドタスクに紐づくアンケートテンプレートID
calloutNoteTemplateId	整数型	アウトバウンドタスクに関連付けられたアウトバウンド業務情報テンプレートID
##### taskFilter

属性名	タイプ	説明
calloutTaskId	整数型	所属するアウトバウンドタスク
conditions	オブジェクト配列	フィルター条件情報、以下を参照
defaultCondition	オブジェクト	デフォルトフィルター、以下を参照

conditions｜defaultCondition

属性名	タイプ	説明
id	整数型	フィルターID
name	文字列	フィルター名
agentIds	配列	このフィルターを使用するオペレーター
option	文字列	フィルタータイプ、all_conditionは以下のすべての条件を満たす、any_conditionは任意の条件を満たす、defaultConditionにはこの値はありません
condition	オブジェクト	フィルター条件、defaultConditionの場合はこの値はありません

condition

属性名	タイプ	説明
fieldName	文字列	フィルターで使用するフィールド
operation	文字列	条件タイプ
value	文字列	条件の値

例

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

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 570,
        "name": "タスクです",
        "startAt": "2021-03-23T15:23:23.000+08:00",
        "endAt": "2021-03-24T15:23:23.000+08:00",
        "createdAt": "2021-03-22T15:26:12.000+08:00",
        "status": "not_start",
        "taskId": 570,
        "customerId": 8915,
        "cellphone": "13812344321",
        "agentIds": [
            19,
            57
        ],
        "questionnaireId": 1,
        "distributionStrategy": "average",
        "calloutNoteTemplateId": 8,
        "hideNumber": true,
        "description": "説明",
        "numberFilterStrategy": "repeatNumber",
        "customerCount": 0,
        "importMethod": "open",
        "holdImportRepeat": "update",
        "sucRate": 0.0,
        "taskFilter": {
            "calloutTaskId": 570,
            "active": 1,
            "permission": "",
            "permissionId": null,
            "groupName": null,
            "creator": null,
            "conditions": [
                {
                    "name": "顧客名フィルター",
                    "id": 2,
                    "agentIds": [
                        19,
                        57
                    ],
                    "option": "all_condition",
                    "condition": [
                        {
                            "fieldName": "name",
                            "operation": "is",
                            "value": "顧客名"
                        }
                    ]
                }
            ],
            "defaultCondition": {
                "name": "顧客データ",
                "id": 1,
                "agentIds": [
                    19,
                    57
                ],
                "option": null,
                "condition": null
            }
        },
        "executedCount": 0,
        "connectedCount": 0
    }
}

---

外呼タスクの作成

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

リクエストメソッド

POST /open_api_v1/outbound_task

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

属性名	タイプ	新規作成時必須	説明
name	文字列	はい	名称
description	文字列		説明
startAt	日時	はい	開始時間
endAt	日時	はい	終了時間
numberFilterStrategy	文字列		番号ポリシー-フィルター設定、デフォルトは repeatNumber
distributionStrategy	文字列	はい	顧客とオペレーターの割り当て戦略。average は均等割り当て（デフォルト）、balance は負荷分散割り当て、manual は手動割り当てです。
hideNumber	ブール型		番号マスキングの有無。true はマスキング、false はマスキングなし（デフォルト）
agentIds	配列		オペレーターIDの配列
questionnaireId	整数		外呼タスクに紐づくアンケートテンプレートID
calloutNoteTemplateId	配列		外呼タスクに関連付ける外呼業務情報テンプレートID
taskFilter	オブジェクト		外呼タスクフィルター

taskFilter

属性名	タイプ	説明
calloutTaskId	整数	所属する外呼タスク
conditions	オブジェクト配列	フィルター条件情報、以下
defaultCondition	オブジェクト	デフォルトフィルター、以下
##### conditions｜defaultCondition

属性名	タイプ	説明
name	文字列	フィルター名
agentIds	配列	このフィルターを使用するオペレーター
option	文字列	フィルタータイプ。all_conditionは以下の条件をすべて満たす、any_conditionは任意の条件を満たす。defaultConditionにはこの値はありません
condition	オブジェクト	フィルター条件。defaultConditionの場合はこの値はありません

condition

属性名	タイプ	説明
fieldName	文字列	フィルターで使用するフィールド
operation	文字列	条件タイプ
value	文字列	条件の値

レスポンスデータ

アウトバウンドタスク詳細の取得と同じです。

例

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task?company_id=1000002&subdomain=demo&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": "Outbound missions in 20211229175404",
    "description": " 無",
    "agentIds": [
        573
    ],
    "distributionStrategy": "average",
    "hideNumber": false,
    "numberFilterStrategy": "repeatNumber",
    "calloutNoteTemplateId": 3,
    "questionnaireId": 101,
    "startAt": "2021-12-07 09:00:00",
    "endAt": "2021-12-25 09:07:44",
    "taskFilter": null
}'

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 988,
        "userId": 18,
        "name": "Outbound missions in 20211229175404",
        "startAt": "2021-12-07 09:00:00",
        "endAt": "2021-12-25 09:07:44",
        "taskType": null,
        "agentType": null,
        "status": "not_start",
        "agentIds": [
            573
        ],
        "queueIds": null,
        "questionnaireId": 101,
        "customFieldId": null,
        "distributionStrategy": "average",
        "calloutNoteTemplateId": 3,
        "hideNumber": false,
        "isRepeatCustomerTask": null,
        "focusCalloutNoteFieldId": null,
        "distributionBasis": null,
        "isNumberMask": null,
        "description": " 無",
        "customDistribution": null,
        "numberFilterStrategy": "repeatNumber",
        "calloutTaskCustomerFilter": null,
        "customerCount": null,
        "sucRate": 0.0,
        "importMethod": "open",
        "holdImportRepeat": "update",
        "taskFilter": null,
        "connectedCount": 0,
        "executedCount": 0
    }
}

---

外呼タスクの更新

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

リクエストメソッド

PUT /open_api_v1/outbound_task/{id}

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

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

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

属性名	タイプ	新規作成時必須	説明
name	文字列	はい	名称
description	文字列		説明
startAt	日時	はい	開始時間
endAt	日時	はい	終了時間
distributionStrategy	文字列	はい	顧客オペレーター割り当て戦略。averageは均等割り当て（デフォルト）、balanceは負荷分散割り当て、manualは手動割り当てです。
hideNumber	ブール型		番号マスキングの有無。trueはマスキング、falseはマスキングしない（デフォルト）です。
agentIds	配列		カスタマーサポートIDの配列
taskFilter	オブジェクト		外呼タスクフィルター

taskFilter

属性名	タイプ	説明
calloutTaskId	整数型	所属する外呼タスク
conditions	オブジェクト配列	フィルター条件情報、以下
defaultCondition	オブジェクト	デフォルトフィルター、以下

conditions｜defaultCondition

属性名	タイプ	説明
name	文字列	フィルター名
agentIds	配列	このフィルターを使用するオペレーター
option	文字列	フィルタータイプ。all_conditionは以下の条件をすべて満たす、any_conditionは任意の条件を満たす。defaultConditionにはこの値はありません。
condition	オブジェクト	フィルター条件。defaultConditionの場合はこの値はありません。
##### condition

属性名	タイプ	説明
fieldName	文字列	フィルターで使用するフィールド
operation	文字列	条件タイプ
value	文字列	条件の値

レスポンスデータ

発信タスク詳細取得APIと同じです。

例

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/1?company_id=1000002&subdomain=demo&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": "外呼任务n",
    "description": "创建新外呼任务",
    "agentIds": [
        19,
        57
    ],
    "distributionStrategy": "balance",
    "hideNumber": true,
    "startAt": "2021-03-22 16:46:15",
    "endAt": "2021-03-24 16:46:15"

}'

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 121,
        "name": "外呼任务哦",
        "startAt": "2021-03-22T16:46:15.000+08:00",
        "endAt": "2021-03-24T16:46:15.000+08:00",
        "createdAt": "2021-03-22T18:07:19.000+08:00",
        "status": "not_start",
        "taskId": 112,
        "customerId": 8915,
        "cellphone": "13812344321",
        "agentIds": [
            19,
            57
        ],
        "queueIds": null,
        "questionnaireId": 6,
        "distributionStrategy": "balance",
        "calloutNoteTemplateId": 4,
        "hideNumber": true,
        "description": "创建新外呼任务",
        "customDistribution": null,
        "numberFilterStrategy": "repeatNumber",
        "customerCount": 0,
        "importMethod": "open",
        "holdImportRepeat": "update",
        "sucRate": 0.0,
        "taskFilter": null,
        "executedCount": 0,
        "connectedCount": 0
    }
}

---

外呼タスクの削除

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

リクエストメソッド

DELETE /open_api_v1/outbound_task/{id}

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

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

レスポンスデータ

属性名	タイプ	説明
succeed	ブール型	実行が成功したかどうか
message	実行結果の説明	実行成功時はOK、それ以外は対応する例外情報を返します

例

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

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false
}

---

外呼タスクの連絡票リストの取得

このAPIは、指定された外呼タスク下のすべての連絡票リストを取得するために使用されます。

リクエストメソッド

GET /open_api_v1/outbound_task/{taskId}/contact_lists

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

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

リクエストパラメータ

パラメータ名	必須	説明
pageNum	いいえ	ページ番号、デフォルトは1
pageSize	いいえ	ページサイズ、デフォルトは10
keyword	いいえ	連絡票のキーワードで検索可能

レスポンスデータ

属性名	タイプ	説明
succeed	ブール型	実行が成功したかどうか
message	実行結果の説明	実行成功時はOK、それ以外は対応する例外情報を返します
paging	オブジェクト	ページング情報
data	オブジェクト配列	連絡票情報、詳細は以下
##### data

属性名	タイプ	説明
id	整数型	連絡リストID
name	文字列	連絡リスト名
status	文字列	連絡リストの状態、not_startは未開始、processingは進行中、expiredは期限切れ、pauseは一時停止
taskId	整数型	所属するアウトバウンドタスクID
customerCount	整数	この連絡リストに含まれる全顧客数
connectRate	文字列	連絡リスト内の顧客実行成功率

例

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

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 4,
        "total": 4
    },
    "data": [
        {
            "id": 28,
            "name": "連絡リスト28",
            "status": "processing",
            "taskId": 112,
            "customerCount": 0,
            "connectRate": "0%"
        }
    ]
}

---

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

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

リクエストメソッド

GET /open_api_v1/outbound_task/customers

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

パラメータ名	必須	説明
taskId	はい	アウトバウンドタスクID
contactListId	いいえ	連絡先リストID
pageNum	いいえ	ページ番号、デフォルトは1
pageSize	いいえ	ページあたりのサイズ、デフォルトは10、最大100

レスポンスデータ

属性名	タイプ	説明
succeed	ブール型	実行が成功したかどうか
message	実行結果の説明	実行成功時はOK、それ以外は対応する例外情報
paging	オブジェクト	ページング情報
data	オブジェクト	タスクデータ

data要素のデータ構造

属性名	タイプ	説明
taskId	整数型	アウトバウンドタスク内のサブタスクID
id	整数型	タスクデータID、顧客IDと区別し、エージェント割り当て時に使用
name	文字列	顧客名
cellphones	配列	顧客の携帯電話リスト
agentId	整数型	カスタマーサポートエージェントID
executedCount	整数型	実行回数
executedResult	文字列	実行結果
contactListId	整数型	連絡先リストID

cellphones要素の構造

属性名	タイプ	説明
name	文字列	対応する英字
content	文字列	電話番号
title	文字列	連絡方法の対応名
### サンプル

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/customers?company_id=1000002&subdomain=demo&taskId=1&pageNum=1&pageSize=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 10,
        "total": 1
    },
    "data": [
        {
            "id": 391,
            "taskId": 112,
            "contactListId": 26,
            "customerId": 8915,
            "name": "これは顧客です",
            "cellphone": "13812344321",
            "cellphones": null,
            "agentId": null,
            "executedCount": null,
            "executedResult": null
        }
    ]
}

---

アウトバウンドタスクのカスタマーサポートリストを取得

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

リクエストメソッド

GET /open_api_v1/outbound_task/callout_tasks/agents

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

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

レスポンスデータ

プロパティ名	タイプ	説明
succeed	ブール型	実行が成功したかどうか
message	実行結果説明	実行成功時はOK、それ以外の場合は対応する例外情報を返します
data	オブジェクト	カスタマーサポートデータ

agents要素のデータ構造

プロパティ名	タイプ	説明
id	整数型	カスタマーサポートID
name	文字列	カスタマーサポート名
customerCount	整数型	顧客数
### サンプル

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/agents?company_id=1000002&subdomain=demo&taskId=1&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": [
        {
            "id": 114,
            "name": "xxx",
            "customerCount": 0
        }
    ]
}

コンタクトリスト作成

このAPIはコンタクトリストを作成するために使用されます。

リクエストメソッド

POST /open_api_v1/outbound_task/contact_list

リクエストパラメータ

パラメータ名	必須	説明
taskId	はい	アウトバウンドタスクID
contactListName	はい	コンタクトリスト名
customers		顧客情報配列。顧客ID、Token、メールアドレス、電話番号を指定可能。複雑なオブジェクト配列の指定もサポート。
agentIds	いいえ	タスクデータを割り当てるエージェント
customerSource	いいえ	顧客ソースチャネル：メールアドレス(email)、電話番号(phone)、ID(id)、Token(apiToken)。デフォルトは電話番号。

customersパラメータ

パラメータ名	必須	説明
value	はい	顧客ID、Token、メールアドレス、電話番号を指定可能
title	いいえ	顧客名
TextField_1	いいえ	カスタムテキストフィールド。【管理センター】-【顧客フィールド】内のカスタムフィールドのフィールドIDに対応。
SelectField_1	いいえ	カスタムフィールド。【管理センター】-【顧客フィールド】内のカスタムフィールドのフィールドIDに対応。フィールドがドロップダウンの場合、値はドロップダウンオプションの値。フィールドが複数選択の場合、複数の値は英語のカンマで区切る。フィールドがカスケードフィールドの場合、値は英語の「|」で区切る。例：北京市|西城区|和谐路

レスポンスデータ

プロパティ名	タイプ	説明
Id	整数	コンタクトリストID
contactListName	文字列	コンタクトリスト名
taskId	整数	所属するアウトバウンドタスクID
status	文字列	コンタクトリストのステータス。0:未開始、1:進行中、2:期限切れ、3:一時停止
### サンプル

curl -X POST \
  https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/contact_list?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' \
  -d '{
    "taskId": 988,
    "contactListName": "連絡先リスト名",
    "agentIds": [
        348
    ],
    "customers": [
        {
            "value": "aa@email.com",
            "title": "顧客名-8",
            "TextField_8": "単行テキストフィールドです",
            "SelectField_12": "オプションD",
            "TextField_9": "2022-08-03 13:23",
            "SelectField_13": "トップ, ジャングル",
            "TextField_16": "13:23:45",
            "TextField_17": "618001",
            "TextField_18": "31400101001",
            "SelectField_17": "天津市|和平区"
        }
    ],
    "customerSource": "email"
}'

レスポンス結果

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1094,
        "contactListName": "Contact form created in 20211229175404",
        "status": "not_start",
        "taskId": 988
    }
}

連絡先リストを更新

このAPIは連絡先リストを更新するために使用されます。

リクエストメソッド

PUT /open_api_v1/outbound_task/contact_list/{id}

リクエストパラメータ

パラメータ名	必須	説明
id	はい	連絡先リストID
customers		顧客情報の配列。顧客ID、Token、メールアドレス、電話番号を指定できます。複雑なオブジェクト配列の指定もサポートされています。
customerSource	いいえ	顧客ソースチャネル：メール（email)、電話番号(phone)、ID(id)、Token(apiToken)。デフォルトは電話番号です。
#### customersパラメータ
パラメータ名	必須	説明
---------------	----	----------
value	はい	顧客ID、トークン、メールアドレス、電話番号を指定できます
title	いいえ	顧客名
TextField_1	いいえ	カスタムテキストフィールド。【管理センター】-【顧客フィールド】内のカスタムフィールドのフィールドIDに対応します
SelectField_1	いいえ	カスタムフィールド。【管理センター】-【顧客フィールド】内のカスタムフィールドのフィールドIDに対応します。フィールドがドロップダウンの場合、値はドロップダウンオプションの値です。フィールドが複数選択の場合、複数の値は英語のカンマで区切ります。フィールドがカスケードフィールドの場合、値は英語の「|」で区切ります。例：北京市|西城区|和谐路

返却データ

属性名	タイプ	説明
Id	整数	コンタクトリストID
status	文字列	コンタクトリストのステータス。0:未開始、1:進行中、2:期限切れ、3:一時停止

サンプル

curl -X PUT \
  https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/contact_list/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' \
  -d '{
    "customers": [
        {
            "value": "24097",
            "title": "顧客名-8",
            "TextField_8": "単行テキストフィールドです",
            "SelectField_12": "オプションD",
            "TextField_9": "2022-08-03 13:23",
            "SelectField_13": "上単,ジャングル",
            "TextField_16": "13:23:45",
            "TextField_17": "618001",
            "TextField_18": "31400101001",
            "SelectField_17": "天津市|和平区"
        }
    ],
    "customerSource": "id"
}'

返却結果

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1094,
        "status": "not_start"
    }
}

コンタクトリストの削除

このAPIはコンタクトリストを削除するために使用されます。

リクエストメソッド

DELETE /open_api_v1/outbound_task/contact_list/{id}

リクエストパラメータ

パラメータ名	必須	説明
id	はい	コンタクトリストID

例

curl -X DELETE \
  https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/contact_list/1?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' 

返却結果

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1094,
        "contactListName": "Contact form created in 20211229175404",
        "status": "not_start",
        "taskId": 988
    }
}

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

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

リクエストメソッド

GET /open_api_v1/outbound_task/template/call_out_notes

リクエストパラメータ

属性名	必須	説明
pageNum	いいえ	ページ番号
pageSize	いいえ	ページあたりのサイズ、デフォルトは10、最大100

返却データ

属性名	タイプ	説明
succeed	ブール型	実行が成功したかどうか
message	実行結果の説明	実行成功時はOK、それ以外は対応する例外情報を返します
paging	オブジェクト	ページング情報
data	オブジェクト配列	アウトバウンド業務テンプレート、詳細は以下
#### data要素のデータ構造

属性名	タイプ	説明
id	整数型	アウトバウンド業務テンプレートID
name	文字列	アウトバウンド業務テンプレート名

サンプル

curl https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/template/call_out_notes?company_id=1000002&subdomain=demo&pageNum=1&pageSize=10&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 10,
        "total": 1
    },
    "data": [
        {
            "id": 1,
            "name": "テスト"
        }
    ]
}

顧客をエージェントに割り当てる

このAPIは、顧客をエージェントに割り当てるために使用されます。

リクエストメソッド

PUT /open_api_v1/outbound_task/distribution

リクエストパラメータ

パラメータ名	必須	説明
agents	はい	割り当て対象エージェントID配列
customerTaskIds		割り当て対象顧客配列、タスクデータID
taskId	いいえ	アウトバウンドタスクID
assignOption	いいえ	割り当て方法、1は均等割り当て（デフォルト）、4は直接割り当て

サンプル

curl -X PUT \
  https://kunapi.s4.udesk.cn/open_api_v1/outbound_task/distribution?company_id=1000002&subdomain=demo&email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2
 \
  -H 'content-type: application/json' \
  -d '{
    "taskId": "988",
    "customerTaskIds": [
        60673
    ],
    "agentIds": [
        573
    ]
}'

返却結果

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false
}