Pular para o conteúdo principal
DELETE
/
api
/
v1
/
accounts
/
{account_id}
/
inbox_members
Remover an agente de Inbox
curl --request DELETE \
  --url https://airys.chat/api/v1/accounts/{account_id}/inbox_members \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "inbox_id": "<string>",
  "user_ids": [
    123
  ]
}
'
import requests

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

payload = {
"inbox_id": "<string>",
"user_ids": [123]
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'DELETE',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({inbox_id: '<string>', user_ids: [123]})
};

fetch('https://airys.chat/api/v1/accounts/{account_id}/inbox_members', 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}/inbox_members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'inbox_id' => '<string>',
'user_ids' => [
123
]
]),
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}/inbox_members"

payload := strings.NewReader("{\n \"inbox_id\": \"<string>\",\n \"user_ids\": [\n 123\n ]\n}")

req, _ := http.NewRequest("DELETE", 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.delete("https://airys.chat/api/v1/accounts/{account_id}/inbox_members")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"inbox_id\": \"<string>\",\n \"user_ids\": [\n 123\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Delete.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inbox_id\": \"<string>\",\n \"user_ids\": [\n 123\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}
{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}
{
"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
inbox_id
string
obrigatório

O ID da caixa de entrada

user_ids
integer[]
obrigatório

IDs dos usuários a serem excluídos da caixa de entrada

Resposta

Sucesso