2.0info: 1.5.0 Gateway WhatsApp description: x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: instant_messaging contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /platform/instant_messagingsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /listProviders: post: description: Lista todos os providers configurados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: includeInactive: type: boolean description: Incluir os providers inativos responses: 200: description: Ok schema: type: object required: – providers properties: providers: #/definitions/provider 401: description: Usuário ou senha inválidos default: description: Error response schema: #/definitions/genericError get: description: Lista todos os providers configurados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: includeInactive: type: boolean description: Incluir os providers inativos responses: 200: description: Ok schema: type: object required: – providers properties: providers: #/definitions/provider 401: description: Usuário ou senha inválidos default: description: Error response schema: #/definitions/genericError /getTenantByNumber: post: description: Tenant da requisição x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – number properties: number: type: string description: To da request responses: 200: description: Ok schema: type: object properties: tenant: type: string description: Tenant 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Tenant da requisição x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – number properties: number: type: string description: To da request responses: 200: description: Ok schema: type: object properties: tenant: type: string description: Tenant 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /saveProvider: post: description: Configura ou atualiza um provider para ser utilizado no envio de mensagens
### Resources:
– res://senior.com.br/platform/instant_messaging/provider_settings
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – settings – description properties: id: type: string description: ID do provider settings: #/definitions/providerSettings description: type: string description: Descrição de uso do provider active: type: boolean description: Ativar/Desativar um provider responses: 200: description: Ok 403: description: Permissão negada 404: description: Não foi encontrada uma configuração para o provedor 401: description: Usuário ou senha inválidos 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /testProvider: post: description: Permite efetuar o teste de um provider previamente cadastrado, o provider nao precisa estar ativo para executar o teste x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – type – destination properties: type: #/definitions/providerType originNumber: type: string description: Número de origem das mensagens, necessário informar quando tiver mais de um provider do mesmo tipo cadastrado destination: type: string description: Número do WhatsApp no formato internacional, exemplo: 41799999999. Apenas são aceitos números válidos no Brasil responses: 200: description: Ok 404: description: Não foi encontrada uma configuração para o provedor 401: description: Usuário ou senha inválidos 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getTenantByProvider: post: description: Tenant da requisição x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – provider properties: provider: type: string description: Id do provider responses: 200: description: Ok schema: type: object properties: tenant: type: string description: Tenant configurado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Tenant da requisição x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – provider properties: provider: type: string description: Id do provider responses: 200: description: Ok schema: type: object properties: tenant: type: string description: Tenant configurado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /sendMessage: post: description: Envio da mensagem x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – content – destination properties: content: #/definitions/content destination: #/definitions/destination origin: #/definitions/service type: #/definitions/providerType originNumber: type: string description: Número de origen das mensagens, necessário informar quando tiver mais de um provider do mesmo tipo cadastrado responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Ticket do envio da mensagem 404: description: Não foi encontrada uma configuração para o provedor 401: description: Usuário ou senha inválidos 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getTenantByPhoneNumber: post: description: Tenant da requisição x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – phoneNumber properties: phoneNumber: type: string description: Número do telefone responses: 200: description: Ok schema: type: object properties: tenant: type: string description: Tenant configurado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError get: description: Tenant da requisição x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – phoneNumber properties: phoneNumber: type: string description: Número do telefone responses: 200: description: Ok schema: type: object properties: tenant: type: string description: Tenant configurado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /removeProvider: post: description: Remover provider x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – settings – description properties: id: type: string description: ID do provider settings: #/definitions/providerSettings description: type: string description: Descrição de uso do provider active: type: boolean description: Ativar/Desativar um provider responses: 200: description: Ok 403: description: Permissão negada 404: description: Não foi encontrada uma configuração para o provedor 401: description: Usuário ou senha inválidos 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: providerType: type: string enum: – TWILIO – INFOBIP – ZENVIA contentType: type: string enum: – PLAINTEXT – HTML – BUTTON provider: type: object required: – id – type – settings – description properties: id: type: string description: Identificador do provider type: #/definitions/providerType settings: #/definitions/providerSettings description: type: string description: Descrição de uso do provider active: type: boolean description: Ativar/Desativar um provider providerSettings: type: object properties: service: type: object required: – domain – service properties: domain: type: string description: Domínio service: type: string description: Serviço content: type: object properties: message: type: string description: Mensagem que sera enviada type: #/definitions/contentType options: type: array items: #/definitions/optionContentRecord description: Opções template: #/definitions/template optionContentRecord: type: object required: – text properties: text: type: string description: Label da opção value: type: string description: Valor da opção url: type: string description: Url da opção template: type: object required: – id – type – fields properties: id: type: string description: template id type: #/definitions/contentType fields: type: array items: #/definitions/templateContentRecord description: Opções templateContentRecord: type: object required: – text – value properties: text: type: string description: Label da opção value: type: string description: Valor da opção destination: type: object required: – to properties: to: type: string description: Telefone do destinário genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE