更新时间:2023-08-17 GMT+08:00
分享

云手机流量导流

功能介绍

手机流量路由修改。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/cloud-phone/phones-traffic

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

traffic_type

String

手机路由类型。

  • direct:默认路由

  • routing:路由到编码容器

phone_ids

Array of strings

手机id列表,一次调用最多支持100个。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求的唯一标识ID。

jobs

Array of PhoneJob objects

任务列表。

表5 PhoneJob

参数

参数类型

描述

phone_id

String

云手机的唯一标识ID,云手机相关任务包含此字段。

job_id

String

任务的唯一标识。

error_code

String

错误码。

error_msg

String

错误说明。

请求示例

修改手机列表中手机的默认路由

POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones-traffic 

{
  "traffic_type" : "routing",
  "phone_ids" : [ "631056bfb66b4f4ea02ba25f04830cb4" ]
}

响应示例

状态码: 200

OK

{
  "request_id" : "6837531fd3f54550927b930180a706bf",
  "jobs" : [ {
    "phone_id" : "631056bfb66b4f4ea02ba25f04830cb4",
    "job_id" : "1564567b8bab40f34711234cb80d0123"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档