get https://{subdomain}.kommo.com/api/v4/sources/
O método retorna um objeto de fonte.
Limitações
O método está disponível de acordo com os direitos do usuário.
Tipo de Autorização
OAuth 2.0 com Token de Acesso/Token de longa duração.
Cabeçalho do tipo de dados em caso de sucesso
Content-Type: application/hal+json
Cabeçalho do tipo de dados em caso de erro
Content-Type: application/problem+json
Parâmetros de resposta
| Parâmetro | Tipo de dado | Descrição |
|---|---|---|
| id | int | ID da fonte |
| name | string | Nome da fonte |
| pipeline_id | int | Pipeline id. O pipeline pode estar arquivado. |
| external_id | string | ID externo da fonte no lado da integração |
| default | bool | Um valor booleano que indica se essa fonte é a fonte padrão. Pode ser nulo. |
| services | array | Um array de serviços associados à fonte. Os dados desse array são usados para exibição no botão de chat do site. |
| services[type] | string | tipo de serviço. Pode estar vazio. |
| services[0][params] | object | Um objeto com configurações da fonte. |
| services[0][params][waba] | bool | Define se a fonte é oficial do WhatsApp. Deve ser adicionada para ativar o funcionamento do Salesbot com modelos aprovados do WhatsApp na nova etapa Enviar Mensagem. Este campo é opcional. |
| services[0][params][is_supports_list_message] | bool | Mostra se a fonte suporta a etapa “Mensagem em Lista” no Salesbot. Deve ser adicionada para exibir uma nova etapa de Mensagem em Lista no Salesbot. |
| services[pages] | string | Contém uma lista de elementos que podem ser selecionados ao configurar o botão de chat do site |
| services[0][pages][0][name] | string | O nome do item exibido ao usuário na lista suspensa ao configurar um botão no site |
| services[0][pages][0][id] | string | Identificador do item na lista suspensa (não exibido para o cliente e usuário) |
| services[0][pages][0][link] | string | O id do usuário que será indicado no botão do mensageiro e para o qual o cliente enviará mensagens na página do site. Por exemplo, para Whatsapp, o link será gerado assim: https://wa.me/{Specified phone number}. |
| origin_code | string null | Código do canal principal da fonte. Este canal de bate-papo será usado ao inicializar o bate-papo. O campo é opcional, mas quando especificado, não deve ser nulo, conter apenas números, ter aspas duplas ou ter mais de 20 caracteres. |
Responses