curl --request POST \
--url https://api.notifique.dev/v1/rcs/instances \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Minha Marca RCS",
"slug": "minha-marca",
"displayName": "Minha Marca"
}
'{
"success": true,
"data": {
"id": "inst_rcs_abc123",
"name": "Minha Marca RCS",
"status": "PENDING",
"slug": "minha-marca",
"displayName": "Minha Marca",
"connectionKind": "comtele",
"onboardingStatus": "DRAFT",
"onboardingError": null,
"googleAgentId": null,
"agentProfile": {
"brandName": "Minha Marca",
"displayName": "Minha Marca",
"hostingRegion": "NORTH_AMERICA",
"billingCategory": "NON_CONVERSATIONAL",
"agentUseCase": "PROMOTIONAL",
"description": "Campanhas e avisos promocionais da Minha Marca.",
"color": "#1A73E8",
"logoUri": "https://cdn.example.com/rcs/logo.png",
"heroUri": "https://cdn.example.com/rcs/hero.png",
"phoneNumbers": [
{
"value": "+551140028922",
"label": "SAC"
}
],
"emails": [
{
"value": "contato@minhamarca.com",
"label": "Suporte"
}
],
"websites": [
{
"uri": "https://minhamarca.com",
"label": "Site"
}
],
"privacy": {
"uri": "https://minhamarca.com/privacidade"
},
"termsConditions": {
"uri": "https://minhamarca.com/termos"
},
"brandContactName": "Maria Silva",
"brandContactEmailAddress": "maria@minhamarca.com",
"brandWebsiteUrl": "https://minhamarca.com",
"attachments": [],
"brazil": {
"cnpj": "12345678000199",
"legalName": "Minha Marca LTDA",
"brandAuthorizationAccepted": true
},
"launch": {
"contacts": [
{
"name": "Maria Silva",
"title": "Marketing",
"email": "maria@minhamarca.com"
}
],
"triggerDescription": "Cliente recebe RCS após opt-in no site.",
"interactionsDescription": "Botões de resposta e links para landing pages.",
"optoutDescription": "Responda SAIR para cancelar.",
"agentAccessInstructions": "Acesse pelo app Mensagens do Android."
}
},
"pendingDisplayName": null,
"pendingAgentProfile": null,
"revisionStatus": "NONE",
"revisionSubmittedAt": null,
"revisionRejectedAt": null,
"revisionRejectionReason": null,
"submittedAt": null,
"createdAt": "2025-02-10T10:00:00.000Z",
"updatedAt": "2025-02-10T10:00:00.000Z",
"awaitingPartner": false,
"revisionAwaitingPartner": false
}
}{
"success": false,
"error": "Bad Request",
"message": "slug must be 2–64 lowercase letters, numbers and hyphens",
"code": "BAD_REQUEST"
}{
"success": false,
"error": "Unauthorized",
"message": "Invalid or missing API Key",
"code": "UNAUTHORIZED"
}{
"success": false,
"error": "Payment Required",
"message": "Trial ended or plan expired. Choose a plan to continue.",
"code": "WORKSPACE_BLOCKED"
}{
"success": false,
"error": "Forbidden",
"message": "Instance limit reached for your plan.",
"code": "PLAN_LIMIT_INSTANCES"
}{
"success": false,
"error": "Conflict",
"message": "RCS slug already taken in this workspace",
"code": "RCS_SLUG_TAKEN"
}Instâncias
Criar instância RCS
Cria um agente RCS branded no workspace. Depois preencha o perfil (agentProfile), submeta com POST .../submit e aguarde aprovação. Guía: Instancias RCS.
POST
/
v1
/
rcs
/
instances
curl --request POST \
--url https://api.notifique.dev/v1/rcs/instances \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Minha Marca RCS",
"slug": "minha-marca",
"displayName": "Minha Marca"
}
'{
"success": true,
"data": {
"id": "inst_rcs_abc123",
"name": "Minha Marca RCS",
"status": "PENDING",
"slug": "minha-marca",
"displayName": "Minha Marca",
"connectionKind": "comtele",
"onboardingStatus": "DRAFT",
"onboardingError": null,
"googleAgentId": null,
"agentProfile": {
"brandName": "Minha Marca",
"displayName": "Minha Marca",
"hostingRegion": "NORTH_AMERICA",
"billingCategory": "NON_CONVERSATIONAL",
"agentUseCase": "PROMOTIONAL",
"description": "Campanhas e avisos promocionais da Minha Marca.",
"color": "#1A73E8",
"logoUri": "https://cdn.example.com/rcs/logo.png",
"heroUri": "https://cdn.example.com/rcs/hero.png",
"phoneNumbers": [
{
"value": "+551140028922",
"label": "SAC"
}
],
"emails": [
{
"value": "contato@minhamarca.com",
"label": "Suporte"
}
],
"websites": [
{
"uri": "https://minhamarca.com",
"label": "Site"
}
],
"privacy": {
"uri": "https://minhamarca.com/privacidade"
},
"termsConditions": {
"uri": "https://minhamarca.com/termos"
},
"brandContactName": "Maria Silva",
"brandContactEmailAddress": "maria@minhamarca.com",
"brandWebsiteUrl": "https://minhamarca.com",
"attachments": [],
"brazil": {
"cnpj": "12345678000199",
"legalName": "Minha Marca LTDA",
"brandAuthorizationAccepted": true
},
"launch": {
"contacts": [
{
"name": "Maria Silva",
"title": "Marketing",
"email": "maria@minhamarca.com"
}
],
"triggerDescription": "Cliente recebe RCS após opt-in no site.",
"interactionsDescription": "Botões de resposta e links para landing pages.",
"optoutDescription": "Responda SAIR para cancelar.",
"agentAccessInstructions": "Acesse pelo app Mensagens do Android."
}
},
"pendingDisplayName": null,
"pendingAgentProfile": null,
"revisionStatus": "NONE",
"revisionSubmittedAt": null,
"revisionRejectedAt": null,
"revisionRejectionReason": null,
"submittedAt": null,
"createdAt": "2025-02-10T10:00:00.000Z",
"updatedAt": "2025-02-10T10:00:00.000Z",
"awaitingPartner": false,
"revisionAwaitingPartner": false
}
}{
"success": false,
"error": "Bad Request",
"message": "slug must be 2–64 lowercase letters, numbers and hyphens",
"code": "BAD_REQUEST"
}{
"success": false,
"error": "Unauthorized",
"message": "Invalid or missing API Key",
"code": "UNAUTHORIZED"
}{
"success": false,
"error": "Payment Required",
"message": "Trial ended or plan expired. Choose a plan to continue.",
"code": "WORKSPACE_BLOCKED"
}{
"success": false,
"error": "Forbidden",
"message": "Instance limit reached for your plan.",
"code": "PLAN_LIMIT_INSTANCES"
}{
"success": false,
"error": "Conflict",
"message": "RCS slug already taken in this workspace",
"code": "RCS_SLUG_TAKEN"
}Autorizações
ntfRcsBearerAuthntfRcsApiKeyHeader
API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx
Corpo
application/json
Resposta
Instância criada em rascunho (DRAFT).
Show child attributes
Show child attributes
Exemplo:
{
"id": "clxx...",
"name": "Exemplo",
"status": "PENDING",
"slug": "string",
"displayName": "string",
"connectionKind": "string",
"onboardingStatus": "DRAFT",
"onboardingError": "string",
"googleAgentId": "clxx...",
"agentProfile": {},
"pendingDisplayName": "string",
"pendingAgentProfile": {},
"revisionStatus": "NONE",
"revisionSubmittedAt": "2025-02-10T14:00:00.000Z",
"revisionRejectedAt": "2025-02-10T14:00:00.000Z",
"revisionRejectionReason": "string",
"submittedAt": "2025-02-10T14:00:00.000Z",
"createdAt": "2025-02-10T14:00:00.000Z",
"updatedAt": "2025-02-10T14:00:00.000Z",
"awaitingPartner": true,
"revisionAwaitingPartner": true
}
Esta página foi útil?

