Pular para o conteúdo principal
POST
/
api
/
v1
/
accounts
/
{account_id}
/
integrations
/
hooks
Criar an integration hook
curl --request POST \
  --url https://airys.chat/api/v1/accounts/{account_id}/integrations/hooks \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "app_id": 1,
  "inbox_id": 1,
  "status": 1,
  "settings": {}
}
'
import requests

url = "https://airys.chat/api/v1/accounts/{account_id}/integrations/hooks"

payload = {
    "app_id": 1,
    "inbox_id": 1,
    "status": 1,
    "settings": {}
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({app_id: 1, inbox_id: 1, status: 1, settings: {}})
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/integrations/hooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://airys.chat/api/v1/accounts/{account_id}/integrations/hooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'app_id' => 1,
    'inbox_id' => 1,
    'status' => 1,
    'settings' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_access_token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://airys.chat/api/v1/accounts/{account_id}/integrations/hooks"

	payload := strings.NewReader("{\n  \"app_id\": 1,\n  \"inbox_id\": 1,\n  \"status\": 1,\n  \"settings\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://airys.chat/api/v1/accounts/{account_id}/integrations/hooks")
  .header("api_access_token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app_id\": 1,\n  \"inbox_id\": 1,\n  \"status\": 1,\n  \"settings\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://airys.chat/api/v1/accounts/{account_id}/integrations/hooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app_id\": 1,\n  \"inbox_id\": 1,\n  \"status\": 1,\n  \"settings\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "app_id": "<string>",
  "inbox_id": "<string>",
  "account_id": "<string>",
  "status": true,
  "hook_type": true,
  "settings": {}
}
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Autorizações

​
api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

​
account_id
integer
obrigatório

O ID numérico da conta

Corpo

application/json
​
app_id
integer

O ID do aplicativo para o qual o hook de integração está sendo criado

Exemplo:

1

​
inbox_id
integer

O ID da caixa de entrada, se o hook for um hook de caixa de entrada

Exemplo:

1

​
status
integer

O status da integração (0 para inativo, 1 para ativo)

Exemplo:

1

​
settings
object

As configurações necessárias para a integração

Exemplo:
{}

Resposta

Sucesso

​
id
string

O ID do hook de integração

​
app_id
string

O ID do aplicativo de integração

​
inbox_id
string

ID da caixa de entrada, se for uma integração de caixa de entrada

​
account_id
string

ID da conta da integração

​
status
boolean

Se o hook de integração está ativado para a conta

​
hook_type
boolean

Se é um hook de integração de conta ou de caixa de entrada

​
settings
object

As configurações associadas à integração