認証

テナントレベル認証

基本情報

Path: /token

Method: GET

インターフェース説明:

1. 認証パラメータ
name 説明
AppId テナントID
Timestamp 10桁のタイムスタンプ(自分で生成する必要があります)
Token 認証署名(5分間有効)。生成方法は第2項を参照してください。
2. 認証署名パラメータ説明

 Token署名HMAC-SHA1 を使用して暗号化され、AppId、Timestamp、Secretから生成する必要があります。生成方法は以下の通りです:

フィールド名 説明 サンプル
メッセージ テナントID + タイムスタンプ a54a8b77-f12d-4ac9-742d-5b2bef5c4d111612513422
アルゴリズム sha1
Secret 秘密鍵(メッセージを暗号化するための鍵)。各テナントには個別の秘密鍵があります。秘密鍵情報は管理者にお問い合わせください。 1234569abcdef
Token メッセージ、アルゴリズム、秘密鍵から生成 5320d95c846d4a26d4b19c762a1d063ec50f4da6

    備考:
      1)  token生成は以下のサイトを参考にできます:  【https://1024tools.com/hmac
      2)  秘密鍵は関連責任者にお問い合わせください

3 リクエストサンプル


【http://ccps.xx.tryudesk.com/api/v1/workTimes?AppId=a54a8b77-f12d-4ac9-742d-5b2bef5c4d11&Timestamp=1612762544&oken=2e511f0b41902747ca5e3aaa1e64754695e96e38】
 

AI自動発信タスクの通話記録を検索

基本情報

Path: /api/v1/call-calls/task

Method: POST

インターフェース説明:

概要

AI発信タスクの通話記録を検索します。通話開始時間と終了時間の間隔は7日を超えてはいけません。

リクエスト

$ curl 'http://ip:port/api/v1/call-calls/task?AppId={appid}&Timestamp={mytime}&Token={token} -i -X POST -H 'Content-Type: application/json' -d '{
    "pageNum":1,
    "pageSize":20,
    "adTaskId":123456,
    "startDateTime":"2022-03-18 10:10:00",
    "endDateTime":"2022-03-18 11:10:00",
    "toNumber":"15888888888"
}'

レスポンス

{
    "succeed": true,
    "code": 200,
    "bizCode": "000000",
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 20,
        "total": 1
    },
    "data": [
        {
            "id": 168,
            "callId": "2a1",
            "workflow": 4,
            "fromNumber": "05388593",
            "toNumber": "15201111111",
            "relayNumber": "05388593",
            "callStartTime": [
                2021,
                10,
                15,
                14,
                26,
                35
            ],
            "callEndTime": [
                2021,
                10,
                15,
                14,
                27,
                23
            ],
            "callDuration": 48,
            "callRecordUrl": "https://prords.iao.com/9ff65-0e6a-767.mp3?OSSAccessKeyId=bPehfu&Expires=16658153&Signature=y7qb%2FStD4%3D",
            "customerProvince": "北京",
            "customerCity": "北京",
            "userAnsweredFlag": 1,
            "userAnsweredCount": 4,
            "userAnsweredEffectiveCount": 2,
            "routerId": null,
            "routerName": null,
            "readFlag": 0,
            "transferAgentFlag": 0,
            "agentId": null,
            "agentName": null,
            "queueId": null,
            "queueName": null,
            "robotNames": [
                "勿动话术"
            ],
            "labelInfos": [
                "11"
            ],
            "adTaskId": 111,
            "variables": null,
            "ringingTime": 16,
            "ringResult": "未选择队列",
            "hangupCause": null,
            "hangupBy": "IVR",
            "adTaskName": "AI外呼",
            "callDirection": "呼出",
            "intentionLabelKey": null,
            "intentionLabelName": null,
            "callResult": 1,
            "calledResult": 1,
            "taskContactBatchName": "联系人A",
            "agentCallDuration": 0,
            "customerNumber": "13394837483",
            "remark": null
        }
    ]
}

リクエストパラメータ

ヘッダー

パラメータ名 パラメータ値 必須かどうか 備考
Content-Type application/json はい

ボディ

名称タイプ必須かどうかデフォルト値備考その他の情報
pageNumnumber必須ではないページ番号、デフォルトは1
pageSizenumber必須ではない1ページあたりの件数、デフォルトは20、最大50
adTaskIdnumber必須タスクID
startDateTimestring必須ではない通話開始時間

mock: 2021-10-10 00:00:00

endDateTimestring必須ではない通話終了時間

mock: 2021-10-17 00:00:00

toNumberstring必須ではない着信番号

返却データ

名称タイプ必須かデフォルト値備考その他の情報
succeedboolean必須成功フラグ
codenumber必須結果コード
bizCodestring必須業務コード
messagestring必須メッセージ
visibleboolean必須表示可否
pagingobject必須ではない
├─ pageNumnumber必須ではないページ番号
├─ pageSizenumber必須ではない1ページあたりの件数
├─ totalnumber必須ではない総数
dataobject []必須ではない

item タイプ: object

├─ idnumber必須ID
├─ callIdstring必須通話ID
├─ workflownumber必須通話タイプ、4-自動発信
├─ fromNumberstring必須発信者番号
├─ toNumberstring必須着信者番号
├─ relayNumberstring必須中継番号
├─ callStartTimestring必須通話開始時間
├─ callEndTimestring必須通話終了時間
├─ callDurationnumber必須通話総時間(秒)
├─ callRecordUrlstring必須通話録音URL
├─ customerProvincestring必須顧客番号の帰属地-省
├─ customerCitystring必須顧客番号の帰属地-市
├─ routerIdnull必須ルーティングID
├─ routerNamenull必須ルーティング名
├─ readFlagnumber必須既読フラグ、0-未読、1-既読
├─ transferAgentFlagnumber必須オペレーターへの転送フラグ、0-否、1-是
├─ agentIdnull必須オペレーターID
├─ agentNamenull必須オペレーター名
├─ queueIdnull必須キューID
├─ queueNamenull必須キュー名
├─ robotNamesstring []必須シナリオ名配列:["シナリオ1","シナリオ2"]

item タイプ: string

├─ 必須ではない
├─ labelInfosstring []必須通常タグ配列:["果物","野菜"]

item タイプ: string

├─ 必須ではない
├─ adTaskIdnumber必須自動発信タスクID
├─ variables

文档反馈

标记内容

点击可标注

错误原因:

问题描述:

联系方式(选填):

确定 取消


Copyright © 2019, Udesk

Documentation built with MkDocs.