Download the PHP package wonittecnologia/interage-sdk-php without Composer
On this page you can find all versions of the php package wonittecnologia/interage-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wonittecnologia/interage-sdk-php
More information about wonittecnologia/interage-sdk-php
Files in wonittecnologia/interage-sdk-php
Package interage-sdk-php
Short Description SDK PHP oficial da API pública de clientes da plataforma Interage+ (Wonit).
License MIT
Informations about the package interage-sdk-php
interage-sdk-php
SDK PHP oficial da API pública de clientes da plataforma Interage+ (Wonit).
- PHP 8.1+, sem dependências — usa só as extensões
curlejson. - Respostas tipadas: cada chamada devolve objetos com propriedades
readonly, datas comoDateTimeImmutablee campos ausentes comonull. - Mesmo contrato do SDK Go.
Instalação
Início rápido
Configuração
new Client(string $baseUrl, string $token, ?Options $options = null)
| Parâmetro | Obrigatório | Descrição |
|---|---|---|
$baseUrl |
sim | Domínio do tenant (ex.: SEU-TENANT.wonit.cloud). Sem scheme, o SDK usa https://. |
$token |
sim | Token de API sk_<valor> (painel administrativo → Tokens de API). |
Options::$timeout |
não | Tempo máximo de cada requisição, em segundos (padrão: 30). |
Options::$insecure |
não | Usa http:// quando a baseUrl vem sem scheme. Só para desenvolvimento local. |
Options::$transport |
não | Transporte HTTP próprio (proxy, cliente HTTP do seu framework, testes). Padrão: curl. |
As permissões de cada rota (leitura, listagem, criação, alteração, remoção) são configuradas por token no painel. Token ausente, inválido, expirado ou revogado responde 401; token válido sem a rota ou sem a ação responde 403.
Domínios
| Propriedade | Cobre |
|---|---|
$cli->campaigns |
Campanhas de disparo WhatsApp |
$cli->messages |
Instâncias, templates HSM e envio de mensagens |
$cli->omni |
Filas, agentes e conversas |
$cli->contacts |
Central de contatos |
$cli->telephony |
Ramais, histórico de ligações, click-to-call e gravações |
Campaigns — campanhas de disparo WhatsApp
Criar campanha com CSV
O CSV deve ter delimitador , ou ; e uma coluna de telefone (phone, telefone,
numero, celular ou whatsapp). Colunas opcionais: name, email, company.
Listar, detalhar e controlar
Messages — instâncias, templates e envio
Omni — filas, agentes e conversas
Contacts — central de contatos
Criar contatos em lote
Até 500 contatos por chamada. Cada item é processado de forma independente — o erro de um não impede os demais.
labelsrecebe o número de cada etiqueta — o número sequencial exibido em Admin → Contatos → Etiquetas. A etiqueta precisa existir e estar ativa; senão o item falha e nada é gravado para aquele contato.customInfoaceita só texto: números e datas vão como string ('1990-05-20').- Limites por contato: nome 255 caracteres, CPF 14, e-mail/empresa 255, até 10
identidades, até 20 etiquetas,
customInfoaté 10 KB.
Telephony — ramais, histórico e click-to-call
Paginação
As listagens devolvem um Page com total, page, pageSize, items e nextCursor.
Campanhas, contatos e histórico de ligações também paginam por cursor, mais
indicado para percorrer listas grandes: passe o nextCursor como cursor da próxima
chamada. nextCursor é null na última página; com cursor informado, a API ignora page.
Tratamento de erros
Toda exceção do SDK implementa WonitTecnologia\Interage\Exception\InterageException.
Erros HTTP viram uma subclasse de ApiException, com $statusCode, $apiStatus,
$apiMessage e $retryAfter.
| Exceção | Quando |
|---|---|
BadRequestException |
400 — parâmetros inválidos |
UnauthorizedException |
401 — token ausente, inválido, expirado ou revogado |
ForbiddenException |
403 — token sem a rota ou sem a ação (libere no painel) |
NotFoundException |
404 — recurso não encontrado |
ConflictException |
409 — conflito de estado (ex.: ramal já em chamada) |
UnprocessableEntityException |
422 — ação não permitida no estado atual |
TooManyRequestsException |
429 — limite de requisições excedido |
ServerException |
5xx — erro interno da API |
TransportException |
falha de rede/conexão, sem resposta da API |
ValidationException |
parâmetro inválido detectado pelo SDK, antes de chamar a API |
UnexpectedResponseException |
resposta de sucesso em formato inesperado |
O SDK não repete requisições sozinho — a decisão de esperar e tentar de novo fica com quem chama.
Testes
Licença
MIT — ver LICENSE.
All versions of interage-sdk-php with dependencies
ext-curl Version *
ext-json Version *