📷 Interativo Instagram

Quick Reply

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{apiId}/sendInteractive/instagram/quickReply

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

messagestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{apiId}/sendInteractive/instagram/quickReply

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/instagram/quickReply HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "ticketId": 123,
  "message": "Escolha uma opção:",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "Sim",
      "payload": "YES"
    },
    {
      "content_type": "text",
      "title": "Não",
      "payload": "NO"
    },
    {
      "content_type": "user_phone_number"
    }
  ]
}

200

Successful response

Button Template

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{apiId}/sendInteractive/instagram/buttonTemplate

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

messagestringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{apiId}/sendInteractive/instagram/buttonTemplate

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/instagram/buttonTemplate HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "ticketId": 123,
  "message": "Clique em uma opção:",
  "buttons": [
    {
      "type": "postback",
      "title": "Comprar",
      "payload": "BUY"
    },
    {
      "type": "postback",
      "title": "Falar com atendente",
      "payload": "HUMAN"
    }
  ]
}

200

Successful response

Generic Template (cards)

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{apiId}/sendInteractive/instagram/genericTemplate

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

ticketIdnumberOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{apiId}/sendInteractive/instagram/genericTemplate

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/sendInteractive/instagram/genericTemplate HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "ticketId": 123,
  "elements": [
    {
      "title": "Produto 1",
      "subtitle": "Descrição",
      "image_url": "https://...",
      "buttons": [
        {
          "type": "postback",
          "title": "Ver",
          "payload": "PROD_1"
        }
      ]
    }
  ]
}

200

Successful response

Ice Breakers (get/set/delete)

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{apiId}/instagram/iceBreakers

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

actionstringOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{apiId}/instagram/iceBreakers

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/instagram/iceBreakers HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "action": "set",
  "iceBreakers": [
    {
      "question": "Qual o horário?",
      "payload": "HOURS"
    },
    {
      "question": "Vocês fazem entrega?",
      "payload": "DELIVERY"
    }
  ]
}

200

Successful response

Persistent Menu (get/set/delete)

post

https://{{BaseUrl}}undefined://{{BASE_URL}}

/v2/api/external/{apiId}/instagram/persistentMenu

Autorizações

bearerAuth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

apiIdstringObrigatório

Parâmetros de cabeçalho

Content-TypestringOpcionalExample: application/json

AuthorizationstringOpcionalExample: Bearer {{API_TOKEN}}

Corpo

application/json

actionstringOpcional

composerInputDisabledbooleanOpcional

Respostas

200

Successful response

application/json

post/v2/api/external/{apiId}/instagram/persistentMenu

HTTPcURLJavaScriptPython

POST /v2/api/external/{apiId}/instagram/persistentMenu HTTP/1.1
Host: {{BaseUrl}}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "action": "set",
  "composerInputDisabled": false,
  "menuItems": [
    {
      "type": "postback",
      "title": "Menu",
      "payload": "MAIN_MENU"
    },
    {
      "type": "web_url",
      "title": "Site",
      "url": "https://..."
    }
  ]
}

200

Successful response