認証
テナントレベル認証
基本情報
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 | はい |
ボディ
| 名称 | タイプ | 必須かどうか | デフォルト値 | 備考 | その他の情報 |
|---|---|---|---|---|---|
| pageNum | number | 必須ではない | ページ番号、デフォルトは1 | ||
| pageSize | number | 必須ではない | 1ページあたりの件数、デフォルトは20、最大50 | ||
| adTaskId | number | 必須 | タスクID | ||
| startDateTime | string | 必須ではない | 通話開始時間 | mock: 2021-10-10 00:00:00 | |
| endDateTime | string | 必須ではない | 通話終了時間 | mock: 2021-10-17 00:00:00 | |
| toNumber | string | 必須ではない | 着信番号 |
返却データ
| 名称 | タイプ | 必須か | デフォルト値 | 備考 | その他の情報 |
|---|---|---|---|---|---|
| succeed | boolean | 必須 | 成功フラグ | ||
| code | number | 必須 | 結果コード | ||
| bizCode | string | 必須 | 業務コード | ||
| message | string | 必須 | メッセージ | ||
| visible | boolean | 必須 | 表示可否 | ||
| paging | object | 必須ではない | |||
| ├─ pageNum | number | 必須ではない | ページ番号 | ||
| ├─ pageSize | number | 必須ではない | 1ページあたりの件数 | ||
| ├─ total | number | 必須ではない | 総数 | ||
| data | object [] | 必須ではない | item タイプ: object | ||
| ├─ id | number | 必須 | ID | ||
| ├─ callId | string | 必須 | 通話ID | ||
| ├─ workflow | number | 必須 | 通話タイプ、4-自動発信 | ||
| ├─ fromNumber | string | 必須 | 発信者番号 | ||
| ├─ toNumber | string | 必須 | 着信者番号 | ||
| ├─ relayNumber | string | 必須 | 中継番号 | ||
| ├─ callStartTime | string | 必須 | 通話開始時間 | ||
| ├─ callEndTime | string | 必須 | 通話終了時間 | ||
| ├─ callDuration | number | 必須 | 通話総時間(秒) | ||
| ├─ callRecordUrl | string | 必須 | 通話録音URL | ||
| ├─ customerProvince | string | 必須 | 顧客番号の帰属地-省 | ||
| ├─ customerCity | string | 必須 | 顧客番号の帰属地-市 | ||
| ├─ routerId | null | 必須 | ルーティングID | ||
| ├─ routerName | null | 必須 | ルーティング名 | ||
| ├─ readFlag | number | 必須 | 既読フラグ、0-未読、1-既読 | ||
| ├─ transferAgentFlag | number | 必須 | オペレーターへの転送フラグ、0-否、1-是 | ||
| ├─ agentId | null | 必須 | オペレーターID | ||
| ├─ agentName | null | 必須 | オペレーター名 | ||
| ├─ queueId | null | 必須 | キューID | ||
| ├─ queueName | null | 必須 | キュー名 | ||
| ├─ robotNames | string [] | 必須 | シナリオ名配列:["シナリオ1","シナリオ2"] | item タイプ: string | |
| ├─ | 必須ではない | ||||
| ├─ labelInfos | string [] | 必須 | 通常タグ配列:["果物","野菜"] | item タイプ: string | |
| ├─ | 必須ではない | ||||
| ├─ adTaskId | number | 必須 | 自動発信タスクID | ||
| ├─ variables |