Obtaining device_token Before Streaming

Function

This API is used for the tenant instance to obtain device_token before streaming.

Before calling this API, ensure that the tenant has purchased an instance.

The obtained device_token of the cloud phone instance is used as the authentication information and carries device_id to call the signaling address (signaling_url) in the response parameter.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, the following identity policy-based permissions are required.

  Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
  koophone:cloudphoneResource:executeInstanceAuthToken	Write	cloudphoneResource *	-	-	-

URI

POST /v1/instances/{instance_id}/auth

Request Parameters

Response Parameters

Status code: 200

Status code: 400

Example Requests

POST API. The request URL carries the instance purchased by the tenant and the tenant token.

/v1/instances/Q39YyZvI/auth

Example Responses

Status code: 200

OK

{
  "data" : {
    "resource" : {
      "sdk" : {
        "internal" : {
          "address" : null,
          "aport" : null,
          "atype" : null,
          "address_ipv6" : null
        },
        "external" : {
          "address" : "10.83.71.187",
          "aport" : 10030,
          "atype" : 1,
          "address_ipv6" : null
        }
      },
      "rtc" : {
        "ice_signaling" : {
          "signaling_url" : "http://100.93.2.248:18082",
          "expired_time" : null,
          "ice_servers" : [ ]
        }
      },
      "device_id" : "7b0cd026df8d495b8a65d628d7bec433",
      "kp_id" : "Q39YyZvI"
    },
    "device_token" : "dee5081f40c83ddea3ded91c387351e9"
  },
  "error_code" : "0",
  "error_msg" : "ok"
}

Status code: 400

Bad Request

{
  "error_code" : "string",
  "error_msg" : "string"
}

Status Codes

Error Codes

See Error Codes.