Consulta as informações de um contato.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ContactId |
string |
Sim |
O ID do contato. |
c-qL4HqKONzOM7**** |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
O resultado retornado. |
||
| RequestId |
string |
O ID da solicitação. |
9B34724D-54B0-4A51-B34D-4512372FE1BE |
| Contact |
object |
As informações sobre o contato. |
|
| ContactId |
string |
O ID do contato. |
c-qL4HqKONzOM7**** |
| MessageTypes |
array |
Os tipos de mensagens recebidas pelo contato. |
|
|
string |
O tipo de mensagem recebida pelo contato. |
AccountExpenses |
|
| CreateDate |
string |
O horário em que o contato foi criado. |
2023-03-27 17:19:21 |
| Name |
string |
O nome do contato. |
tom |
| EmailAddress |
string |
O endereço de e-mail do contato. |
someone***@example.com |
| PhoneNumber |
string |
O número de telefone celular do contato. |
86-139****1234 |
| Title |
string |
O cargo do contato. |
TechnicalDirector |
| Members |
array |
Os IDs dos objetos aos quais o contato está vinculado. |
|
|
string |
O ID do objeto ao qual o contato está vinculado. |
fd-ZDNPiT**** |
|
| Status |
string |
O status do contato. Valores válidos:
|
Active |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"Contact": {
"ContactId": "c-qL4HqKONzOM7****",
"MessageTypes": [
"AccountExpenses"
],
"CreateDate": "2023-03-27 17:19:21",
"Name": "tom",
"EmailAddress": "someone***@example.com",
"PhoneNumber": "86-139****1234",
"Title": "TechnicalDirector",
"Members": [
"fd-ZDNPiT****"
],
"Status": "Active"
}
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | InvalidParameter.ContactId | The ContactId is invalid. | |
| 400 | MissingParameter.ContactId | You must specify ContactId. | |
| 404 | EntityNotExists.Contact | This Contact does not exist. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.