Obtém tickets de conexão em lote. Esta operação gera tickets de conexão de forma assíncrona. Na maioria dos casos, os tickets são retornados diretamente na resposta da primeira chamada. No entanto, em algumas situações, a resposta inicial conterá um TaskId. Você deve então consultar este endpoint com o TaskId até que a geração seja concluída e os tickets sejam retornados.
Descrição da operação
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| InstanceGroupId |
string |
Não |
O ID do grupo de instâncias. |
ag-25nt4kk9whjh**** |
| InstanceIds |
array |
Não |
Os IDs das instâncias de telefone em nuvem. Você pode especificar de 1 a 100 IDs de instâncias de telefone em nuvem. |
|
|
string |
Não |
O ID da instância de telefone em nuvem. |
acp-bj9t2gmys**** |
|
| EndUserId |
string |
Não |
O ID do usuário ao qual a instância de telefone em nuvem está atribuída. |
user |
| ConnectionMode |
string |
Não |
O modo de conexão. |
custom |
| InstanceTasks |
array<object> |
Não |
A tarefa de conexão da instância, utilizada para consultar se a tarefa de obtenção de ticket foi concluída. |
|
|
object |
Não |
A tarefa de conexão da instância. |
||
| InstanceId |
string |
Não |
O ID da instância de telefone em nuvem. |
acp-fkuit0cmyfvzz**** |
| TaskId |
string |
Não |
O ID da tarefa. |
cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94**** |
| Ports |
array |
Não |
||
|
string |
Não |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Os parâmetros de resposta. |
||
| RequestId |
string |
O ID da solicitação. |
7B9EFA4F-4305-5968-BAEE-BD8B8DE5**** |
| InstanceConnectionModels |
array<object> |
Os resultados das tarefas de conexão da instância. |
|
|
object |
O resultado da tarefa de conexão da instância. |
||
| AppInstanceGroupId |
string |
O ID do grupo de entrega. |
aig-1uzb6heg797z3**** |
| InstanceId |
string |
O ID da instância de telefone em nuvem. |
acp-ajxvwo1u0hqvd**** |
| TaskStatus |
string |
O estado da tarefa. Se FINISHED for retornado, indica que um valor pode ser obtido do campo Ticket. Se o valor retornado não for FINISHED, você ainda precisa usar esta operação para consultar o resultado da geração do Ticket usando o TaskId. |
FINISHED |
| TaskId |
string |
O ID da tarefa. |
cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94**** |
| Ticket |
string |
O ticket utilizado para conectar-se à instância de telefone em nuvem. |
piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3**** |
| ErrorCode |
string |
InvalidResourceId.NotFound |
|
| PersistentAppInstanceId |
string |
p-abdywvcksdb**** |
|
| AppInstanceId |
string |
ai-0caoetkqi8kj**** |
|
| Port |
integer |
A porta utilizada para estabelecer uma conexão. |
10000 |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "7B9EFA4F-4305-5968-BAEE-BD8B8DE5****",
"InstanceConnectionModels": [
{
"AppInstanceGroupId": "aig-1uzb6heg797z3****",
"InstanceId": "acp-ajxvwo1u0hqvd****",
"TaskStatus": "FINISHED",
"TaskId": "cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****",
"Ticket": "piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3****",
"ErrorCode": "InvalidResourceId.NotFound",
"PersistentAppInstanceId": "p-abdywvcksdb****",
"AppInstanceId": "ai-0caoetkqi8kj****",
"Port": 10000
}
]
}Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.