文档首页 > > API参考> 话务机器人> 话务会话API>

结束会话

结束会话

分享
更新时间:2021/03/08 GMT+08:00

功能介绍

结束话务机器人会话。如果会话持续10分钟无会话请求则被清理。

URI

  • URI格式
    DELETE /v1/{project_id}/taskbot/voicecall/bots/{bot_id}/sessions/{session_id}
  • 参数说明
    表1 URI参数说明

    名称

    是否必选

    说明

    project_id

    项目ID,用于资源隔离。请参见获取项目ID

    bot_id

    话务机器人ID。

    进入话务机器人的Console界面,在“机器人名称/ID”列显示对应的bot_id。

    session_id

    会话ID。具体获取方式请参见开启会话章节。

请求消息

请求参数

无。

响应消息

响应参数如表2所示。
表2 响应参数

名称

参数类型

说明

error_code

String

调用失败时的错误码。

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

示例

  • 请求示例
    DELETE https://{endpoint}/v1/E9993fc787d94b6c886cbaa340f9c0f4/taskbot/voicecall/bots/b1e2e409-d3f3-4916-9802-b489b5582f97/sessions/28d01720-c180-42ac-bbaf-51e0b4d9691d
    
    Request Header:
        Content-Type: application/json
        X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • Python语言请求代码示例
    import requests
    url = "https://{endpoint}/v1/{project_id}/taskbot/voicecall/bots/{bot_id}/sessions/{session_id}"  # session_id是发起会话返回的id
    token = "用户获取得到的实际token值"
    headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
    
    response = requests.delete(url, headers=headers, verify=False)
    print(response.text)
  • 响应示例
    • 成功响应示例

      无。

    • 失败响应示例
      {
          "error_code":"CBS.6845",
          "error_msg":"session is deleted failed"
      }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品