Consulta do status do terminal
Descrição
Esta API é usada para consultar o status de um terminal físico.
O terminal físico e a conta que inicia a solicitação de consulta devem pertencer à mesma empresa. Caso contrário, a autenticação falha.
SLA
Taxa de sucesso de solicitação: > 99,99%
Atraso na solicitação TP99: 101 ms
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
Método de solicitação |
POST |
---|---|
Endereço de solicitação |
/v1/usg/acs/ap/userstatus |
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
---|---|---|---|---|
X-Access-Token |
Sim |
String |
Cabeçalho |
Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação. |
X-Request-Id |
Não |
String |
Cabeçalho |
ID da solicitação, que é usado para rastreamento e localização de falhas. É aconselhável usar um UUID. Se este parâmetro não for transportado, um ID de solicitação é gerado automaticamente. |
Accept-Language |
Não |
String |
Cabeçalho |
Idioma. Valores: zh-CN para chinês (padrão) e en-US para inglês. |
[Array element] |
Sim |
Array of strings |
Corpo |
Número do terminal a consultar. |
Códigos de status
Código de status HTTP |
Descrição |
---|---|
200 |
Operação bem-sucedida. |
400 |
Parâmetros inválidos. |
401 |
A autenticação não é executada ou falha. |
403 |
Permissões insuficientes. |
500 |
Exceção do servidor. |
Parâmetros de resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
[Array element] |
Array of UserStatusDTO |
Lista de status dos dispositivos. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
CallStatus |
String |
Status da chamada.
|
Number |
String |
Número do terminal. |
RegStatus |
String |
Status do registro.
|
Exemplo de solicitação
POST /v1/usg/acs/ap/userstatus Connection: keep-alive X-Access-Token: stbtsadx6U2jBKxODtf3Ylnff5uGZX8mzu1K content-type: application/json Content-Length: 40 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_131) [ "+99*******" ]
Exemplo de resposta
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: a48502799c8d43519ba81502110cf213 [ { "Number": "tel:+991116173924", "RegStatus": "0", "CallStatus": "1" } ]
Códigos de erro
Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.
Exemplo de comando cURL
curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbtsadx6U2jBKxODtf3Ylnff5uGZX8mzu1K' -d '["+99*******"]' https://api.meeting.huaweicloud.com/v1/usg/acs/ap/userstatus