Gelen kutusu API

Tüm kanallar tek gelen kutusunda — konuşmalar, yanıtlar, ekipler ve kimin yanıtladığı.

Modül kodu inbox · 63 işlem · 22 veri modeli · 45 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: inbox (hepsi), inbox:read (yalnız okuma) ya da inbox:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

inbox.add_participant

Takipçi ekle — Birinin atanmadan konuşmayı takip etmesini sağlar.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.add_participant

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.participant_added

Neye yazar: conversation_participant (insert) — Adds the follower

curl -X POST https://app.getera.io/api/v1/conversation_participants/actions/add_participant \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"CONVERSATION_ID","userId":"USER_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.participant_added"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversationParticipants.addParticipant({
  id: "CONVERSATION_ID",
  userId: "USER_ID"
})

era conversation_participants add_participant \
  --id "CONVERSATION_ID" \
  --user-id "USER_ID"

{
  "name": "era__inbox__add_participant",
  "arguments": {
    "id": "CONVERSATION_ID",
    "userId": "USER_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, not_a_member, already_participating · 429 çok sık istek

inbox.add_private_note

Özel not ekle — Konuşmaya müşterinin asla görmediği bir not bırakır.

Gereken izin inbox:comment · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.add_private_note

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.note_added, inbox.mentioned, inbox.user_mentioned

Neye yazar: message (insert) — Writes the private note; message_attachment (insert) — Attaches files; conversation (update) — Touches the activity clock; conversation_mention (upsert) — Records who was mentioned; conversation_participant (insert) — Makes the people mentioned followers

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/add_private_note \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"content":"Message"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.note_added",
    "inbox.mentioned",
    "inbox.user_mentioned"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.addPrivateNote("CONVERSATION_ID", {
  content: "Message"
})

era conversations add_private_note CONVERSATION_ID \
  --content "Message"

{
  "name": "era__inbox__add_private_note",
  "arguments": {
    "conversationId": "CONVERSATION_ID",
    "content": "Message"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:comment izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, empty_message, too_many_attachments, too_many_messages, canned_response_not_found, mentioned_cannot_read · 429 çok sık istek

inbox.apply_sla

SLA uygula — Bir konuşmayı bir yanıt süresi politikasına göre ölçer.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.apply_sla

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.sla_applied, inbox.sla_missed

Neye yazar: applied_sla (insert) — Starts measuring; sla_event (insert) — Records a target already missed

curl -X POST https://app.getera.io/api/v1/applied_slas/actions/apply_sla \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"conversationId":"CONVERSATION_ID","policyId":"SLA_POLICY_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.sla_applied",
    "inbox.sla_missed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.appliedSlas.applySla({
  conversationId: "CONVERSATION_ID",
  policyId: "SLA_POLICY_ID"
})

era applied_slas apply_sla \
  --conversation-id "CONVERSATION_ID" \
  --policy-id "SLA_POLICY_ID"

{
  "name": "era__inbox__apply_sla",
  "arguments": {
    "conversationId": "CONVERSATION_ID",
    "policyId": "SLA_POLICY_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, sla_policy_not_found, sla_already_applied · 429 çok sık istek

inbox.assign

Konuşmayı ata — Konuşmayı o gelen kutusunda çalışan birine verir ya da kuyruğa geri koyar.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.assign

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.assigned

Neye yazar: conversation (update) — Sets the assignee

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/assign \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"userId":"USER_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.assigned"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.assign("CONVERSATION_ID", {
  userId: "USER_ID"
})

era conversations assign CONVERSATION_ID \
  --user-id "USER_ID"

{
  "name": "era__inbox__assign",
  "arguments": {
    "id": "CONVERSATION_ID",
    "userId": "USER_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, not_a_member, not_an_inbox_member, not_in_conversation_team · 429 çok sık istek

inbox.assign_bot

Konuşmayı bota devret — Konuşmayı o gelen kutusuna bağlı bir bota verir ya da geri alır.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.assign_bot

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.assigned, inbox.bot_handoff

Neye yazar: conversation (update) — Sets or clears the bot; reporting_event (insert) — Writes the report clock reading (sql/126)

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/assign_bot \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"agentBotId":"AGENT_BOT_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.assigned",
    "inbox.bot_handoff"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.assignBot("CONVERSATION_ID", {
  agentBotId: "AGENT_BOT_ID"
})

era conversations assign_bot CONVERSATION_ID \
  --agent-bot-id "AGENT_BOT_ID"

{
  "name": "era__inbox__assign_bot",
  "arguments": {
    "id": "CONVERSATION_ID",
    "agentBotId": "AGENT_BOT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, bot_not_on_inbox · 429 çok sık istek

inbox.assign_era

Bir konuşmayı Era’ya ver — Era her yanıtı özel not olarak taslak yazar ya da yanıtlar — izin vermediysen yanıt yine onayını bekler.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.assign_era

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.era_assigned

Neye yazar: conversation (update) — Gives the conversation to Era, or takes it back

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/assign_era \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"mode":"draft"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.era_assigned"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.assignEra("CONVERSATION_ID", {
  mode: "draft"
})

era conversations assign_era CONVERSATION_ID \
  --mode "draft"

{
  "name": "era__inbox__assign_era",
  "arguments": {
    "id": "CONVERSATION_ID",
    "mode": "draft"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, era_off · 429 çok sık istek

inbox.assign_team

Konuşmayı ekibe taşı — Konuşmayı bir ekibe yönlendirir; ekipte olmayan atananı çıkarır.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.assign_team

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.team_assigned

Neye yazar: conversation (update) — Sets the team

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/assign_team \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"teamId":"TEAM_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.team_assigned"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.assignTeam("CONVERSATION_ID", {
  teamId: "TEAM_ID"
})

era conversations assign_team CONVERSATION_ID \
  --team-id "TEAM_ID"

{
  "name": "era__inbox__assign_team",
  "arguments": {
    "id": "CONVERSATION_ID",
    "teamId": "TEAM_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, team_not_found · 429 çok sık istek

inbox.auto_assign

Otomatik ata — Sıradaki temsilciyi gelen kutusunun yönlendirme kuralına göre, adil payı içinde seçer.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.auto_assign

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.assigned

Neye yazar: conversation (update) — Sets the assignee; inbox_member (update) — Moves the agent to the back of the queue

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/auto_assign \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.assigned"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.autoAssign("CONVERSATION_ID")

era conversations auto_assign CONVERSATION_ID

{
  "name": "era__inbox__auto_assign",
  "arguments": {
    "id": "CONVERSATION_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, inbox_not_found, auto_assignment_off, policy_disabled · 429 çok sık istek

inbox.bot_reply

Bot yanıtlar — Botun müşteriye söyledikleri, bot API’si üzerinden.

Gereken izin inbox:handle · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

• Asıl adres: POST /api/v1/actions/inbox.bot_reply

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.message_sent

Neye yazar: message (insert) — Writes the bot’s message, queued for delivery; conversation (update) — Clears the waiting clock

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/bot_reply \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"agentBotId":"AGENT_BOT_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.message_sent"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.botReply("CONVERSATION_ID", {
  agentBotId: "AGENT_BOT_ID"
})

era conversations bot_reply CONVERSATION_ID \
  --agent-bot-id "AGENT_BOT_ID"

{
  "name": "era__inbox__bot_reply",
  "arguments": {
    "conversationId": "CONVERSATION_ID",
    "agentBotId": "AGENT_BOT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:handle izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 agent_bot_not_found, conversation_not_found, bot_not_on_inbox, unsupported_content_type, empty_message, conversation_resolved, too_many_messages · 429 çok sık istek

inbox.bot_set_status

Bot devreder ya da çözer — Bot konuşmayı ekibe verir ya da kapatır.

Gereken izin inbox:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.bot_set_status

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.bot_handoff, inbox.resolved, inbox.message_sent

Neye yazar: conversation (update) — Opens it for people, or resolves it; message (insert) — The rating request, when resolving asks for one; reporting_event (insert) — Writes the report clock reading (sql/126)

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/bot_set_status \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"agentBotId":"AGENT_BOT_ID","status":"open"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.bot_handoff",
    "inbox.resolved",
    "inbox.message_sent"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.botSetStatus("CONVERSATION_ID", {
  agentBotId: "AGENT_BOT_ID",
  status: "open"
})

era conversations bot_set_status CONVERSATION_ID \
  --agent-bot-id "AGENT_BOT_ID" \
  --status "open"

{
  "name": "era__inbox__bot_set_status",
  "arguments": {
    "conversationId": "CONVERSATION_ID",
    "agentBotId": "AGENT_BOT_ID",
    "status": "open"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:handle izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 agent_bot_not_found, conversation_not_found, bot_not_on_inbox, already_open, already_resolved · 429 çok sık istek

inbox.bulk_update

Birden çok konuşmayı değiştir — Bir seçimi tek seferde çözer, erteler, atar, yönlendirir veya önceliklendirir — hepsi ya da hiçbiri.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.bulk_update

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.assigned, inbox.team_assigned, inbox.resolved, inbox.reopened, inbox.snoozed, inbox.priority_changed, inbox.message_sent

Neye yazar: conversation (update) — Applies the change to each conversation; inbox_member (update) — Moves an assignee to the back of the queue; message (insert) — A rating request, when resolving asks for one; reporting_event (insert) — Writes the report clock reading (sql/126)

curl -X POST https://app.getera.io/api/v1/messages/actions/bulk_update \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"ids":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.assigned",
    "inbox.team_assigned",
    "inbox.resolved",
    "inbox.reopened",
    "inbox.snoozed",
    "inbox.priority_changed",
    "inbox.message_sent"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.messages.bulkUpdate({
  ids: {}
})

era messages bulk_update --data '{"ids":{}}'

{
  "name": "era__inbox__bulk_update",
  "arguments": {
    "ids": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 invalid_selection, nothing_to_change · 429 çok sık istek

inbox.change_customer

Konuşmayı başka bir kişiye taşı — Konuşmanın kiminle olduğunu düzeltir; geldiği kanal adresini korur.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.change_customer

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.customer_changed

Neye yazar: conversation (update) — Repoints the conversation

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/change_customer \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"customerId":"CUSTOMER_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.customer_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.changeCustomer("CONVERSATION_ID", {
  customerId: "CUSTOMER_ID"
})

era conversations change_customer CONVERSATION_ID \
  --customer-id "CUSTOMER_ID"

{
  "name": "era__inbox__change_customer",
  "arguments": {
    "id": "CONVERSATION_ID",
    "customerId": "CUSTOMER_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, customer_not_found, customer_archived · 429 çok sık istek

inbox.create_inbox

Kanal bağla — Desteklenen kanallardan birinde yeni bir gelen kutusu açar.

Gereken izin inbox:manage · veriyi değiştirir

• REST kısayolu: POST /api/v1/inboxes
• Asıl adres: POST /api/v1/actions/inbox.create_inbox

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.channel_connected

Neye yazar: inbox (insert) — Opens the channel; inbox_member (insert) — Records who works it

curl -X POST https://app.getera.io/api/v1/inboxes/actions/create_inbox \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name","channelType":"web_widget"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.channel_connected"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.inboxes.create({
  name: "Name",
  channelType: "web_widget"
})

era inboxes create \
  --name "Name" \
  --channel-type "web_widget"

{
  "name": "era__inbox__create_inbox",
  "arguments": {
    "name": "Name",
    "channelType": "web_widget"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 identifier_taken, channel_config_incomplete, not_a_member, mailbox_connection_required, mailbox_not_mail_app, connection_not_usable, connection_not_found, connection_inactive · 429 çok sık istek

inbox.deactivate_inbox

Kanalı hizmetten çıkar — Gelen kutusunun yeni konuşma almasını durdurur; içindekileri korur.

Gereken izin inbox:manage · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/inbox.deactivate_inbox

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.channel_deactivated

Neye yazar: inbox (update) — Marks the channel inactive

curl -X POST https://app.getera.io/api/v1/inboxes/INBOXE_ID/actions/deactivate_inbox \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.channel_deactivated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.inboxes.deactivateInbox("INBOXE_ID")

era inboxes deactivate_inbox INBOXE_ID

{
  "name": "era__inbox__deactivate_inbox",
  "arguments": {
    "id": "INBOXE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 inbox_not_found, inbox_has_open_conversations · 429 çok sık istek

inbox.delete_agent_bot

Botu kaldır — Botu kaldırır; elindeki konuşmalar ekibe geçer.

Gereken izin inbox:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• REST kısayolu: DELETE /api/v1/agent_bots/{id}
• Asıl adres: POST /api/v1/actions/inbox.delete_agent_bot

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.agent_bot_changed

Neye yazar: conversation (update) — Hands its pending conversations to people; agent_bot (delete) — Removes the bot and its inbox bindings

curl -X POST https://app.getera.io/api/v1/agent_bots/AGENT_BOT_ID/actions/delete_agent_bot \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.agent_bot_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.agentBots.deleteAgentBot("AGENT_BOT_ID")

era agent_bots delete_agent_bot AGENT_BOT_ID

{
  "name": "era__inbox__delete_agent_bot",
  "arguments": {
    "id": "AGENT_BOT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 agent_bot_not_found · 429 çok sık istek

inbox.delete_canned_response

Hazır yanıtı sil — Bir kısa kodu yazma alanından kaldırır.

Gereken izin inbox:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• REST kısayolu: DELETE /api/v1/canned_responses/{id}
• Asıl adres: POST /api/v1/actions/inbox.delete_canned_response

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.canned_response_changed

Neye yazar: canned_response (delete) — Removes the saved reply

curl -X POST https://app.getera.io/api/v1/canned_responses/CANNED_RESPONSE_ID/actions/delete_canned_response \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.canned_response_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.cannedResponses.deleteCannedResponse("CANNED_RESPONSE_ID")

era canned_responses delete_canned_response CANNED_RESPONSE_ID

{
  "name": "era__inbox__delete_canned_response",
  "arguments": {
    "id": "CANNED_RESPONSE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 canned_response_not_found · 429 çok sık istek

inbox.delete_macro

Makroyu sil — Bir makroyu kaldırır.

Gereken izin inbox:write · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• REST kısayolu: DELETE /api/v1/macros/{id}
• Asıl adres: POST /api/v1/actions/inbox.delete_macro

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.macro_changed

Neye yazar: macro (delete) — Removes the macro

curl -X POST https://app.getera.io/api/v1/macros/MACRO_ID/actions/delete_macro \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.macro_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.macros.deleteMacro("MACRO_ID")

era macros delete_macro MACRO_ID

{
  "name": "era__inbox__delete_macro",
  "arguments": {
    "id": "MACRO_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 macro_not_found, not_macro_owner · 429 çok sık istek

inbox.delete_message

Mesajı sil — Mesajı konuşmadan kaldırır; denetim kaydı için satırı saklar.

Gereken izin inbox:delete · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• REST kısayolu: DELETE /api/v1/messages/{id}
• Asıl adres: POST /api/v1/actions/inbox.delete_message

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.message_deleted

Neye yazar: message (update) — Writes the tombstone

curl -X POST https://app.getera.io/api/v1/messages/MESSAGE_ID/actions/delete_message \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.message_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.messages.deleteMessage("MESSAGE_ID")

era messages delete_message MESSAGE_ID

{
  "name": "era__inbox__delete_message",
  "arguments": {
    "id": "MESSAGE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:delete izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 message_not_found · 429 çok sık istek

inbox.delete_sla_policy

SLA politikasını sil — Hiçbir şeyin ona göre ölçülmediği bir politikayı kaldırır.

Gereken izin inbox:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• REST kısayolu: DELETE /api/v1/sla_policies/{id}
• Asıl adres: POST /api/v1/actions/inbox.delete_sla_policy

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.sla_policy_changed

Neye yazar: sla_policy (delete) — Deletes the policy

curl -X POST https://app.getera.io/api/v1/sla_policies/SLA_POLICY_ID/actions/delete_sla_policy \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.sla_policy_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.slaPolicies.deleteSlaPolicy("SLA_POLICY_ID")

era sla_policies delete_sla_policy SLA_POLICY_ID

{
  "name": "era__inbox__delete_sla_policy",
  "arguments": {
    "id": "SLA_POLICY_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 sla_policy_not_found, sla_policy_in_use · 429 çok sık istek

inbox.delete_team

Ekibi sil — Bir ekibi kaldırır; konuşmaları ekipsiz kalır.

Gereken izin inbox:manage · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• REST kısayolu: DELETE /api/v1/teams/{id}
• Asıl adres: POST /api/v1/actions/inbox.delete_team

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.team_changed

Neye yazar: team (delete) — Removes the team

curl -X POST https://app.getera.io/api/v1/teams/TEAM_ID/actions/delete_team \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"force":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.team_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.teams.deleteTeam("TEAM_ID", {
  force: true
})

era teams delete_team TEAM_ID \
  --force true

{
  "name": "era__inbox__delete_team",
  "arguments": {
    "id": "TEAM_ID",
    "force": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 team_not_found, team_has_open_conversations · 429 çok sık istek

inbox.edit_message

Mesajı düzenle — Gönderdiğiniz bir mesajı düzeltir.

Gereken izin inbox:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

• Asıl adres: POST /api/v1/actions/inbox.edit_message

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.message_edited

Neye yazar: message (update) — Rewrites the message and marks it edited

curl -X POST https://app.getera.io/api/v1/messages/MESSAGE_ID/actions/edit_message \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"content":"Message"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.message_edited"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.messages.editMessage("MESSAGE_ID", {
  content: "Message"
})

era messages edit_message MESSAGE_ID \
  --content "Message"

{
  "name": "era__inbox__edit_message",
  "arguments": {
    "id": "MESSAGE_ID",
    "content": "Message"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 message_not_found, message_not_editable, empty_message · 429 çok sık istek

inbox.evaluate_sla

SLA’yı kontrol et — Konuşmanın kaçırdığı hedefleri kaydeder ve çözüldüğünde tutuldu veya kaçırıldı olarak kesinleştirir.

Gereken izin inbox:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.evaluate_sla

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.sla_missed, inbox.sla_closed

Neye yazar: applied_sla (update) — Writes the status and the next deadline; sla_event (insert) — One row per missed target

curl -X POST https://app.getera.io/api/v1/applied_slas/APPLIED_SLA_ID/actions/evaluate_sla \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.sla_missed",
    "inbox.sla_closed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.appliedSlas.evaluateSla("APPLIED_SLA_ID")

era applied_slas evaluate_sla APPLIED_SLA_ID

{
  "name": "era__inbox__evaluate_sla",
  "arguments": {
    "id": "APPLIED_SLA_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:handle izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 applied_sla_not_found · 429 çok sık istek

inbox.ingest

Gelen mesajı al — Bir kanala gelen mesajı kaydeder; yeniyse konuşmayı açar.

Gereken izin inbox:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.ingest

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.message_received, inbox.conversation_opened, inbox.reopened, inbox.message_sent

Neye yazar: conversation (upsert) — Finds the thread, or opens a new one; message (insert) — Files what arrived; message_attachment (insert) — Files what came with it; reporting_event (insert) — Writes the report clock reading (sql/126)

curl -X POST https://app.getera.io/api/v1/conversations/actions/ingest \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"inboxId":"INBOX_ID","customerId":"CUSTOMER_ID","sourceId":"The provider’s id for this message"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.message_received",
    "inbox.conversation_opened",
    "inbox.reopened",
    "inbox.message_sent"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.ingest({
  inboxId: "INBOX_ID",
  customerId: "CUSTOMER_ID",
  sourceId: "The provider’s id for this message"
})

era conversations ingest \
  --inbox-id "INBOX_ID" \
  --customer-id "CUSTOMER_ID" \
  --source-id "The provider’s id for this message"

{
  "name": "era__inbox__ingest",
  "arguments": {
    "inboxId": "INBOX_ID",
    "customerId": "CUSTOMER_ID",
    "sourceId": "The provider’s id for this message"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:handle izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 inbox_not_found, inbox_inactive, no_source_id, empty_message, malformed_message, duplicate_message, customer_not_found, customer_archived · 429 çok sık istek

inbox.mark_read

Okundu işaretle — Konuşmanın görüldüğünü kaydeder.

Gereken izin inbox:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.mark_read

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Neye yazar: conversation (update) — Stamps the read marks

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/mark_read \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": []
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.markRead("CONVERSATION_ID")

era conversations mark_read CONVERSATION_ID

{
  "name": "era__inbox__mark_read",
  "arguments": {
    "id": "CONVERSATION_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found · 429 çok sık istek

inbox.mark_unread

Okunmadı olarak işaretle — Okundu işaretini ilk gelen mesajın gerisine çeker; böylece konuşma okunmamışlar listesine döner.

Gereken izin inbox:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.mark_unread

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Neye yazar: conversation (update) — Moves the read marker back

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/mark_unread \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": []
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.markUnread("CONVERSATION_ID")

era conversations mark_unread CONVERSATION_ID

{
  "name": "era__inbox__mark_unread",
  "arguments": {
    "id": "CONVERSATION_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found · 429 çok sık istek

inbox.mute

Sessize al — Konuşmayı çözer ve kişinin sonra göndereceklerini konuşmayı yeniden açmadan kaydeder.

Gereken izin inbox:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/inbox.mute

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: inbox.muted

Neye yazar: conversation (update) — Mutes and resolves it; reporting_event (insert) — Writes the report clock reading (sql/126)

curl -X POST https://app.getera.io/api/v1/conversations/CONVERSATION_ID/actions/mute \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "inbox.muted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.conversations.mute("CONVERSATION_ID")

era conversations mute CONVERSATION_ID

{
  "name": "era__inbox__mute",
  "arguments": {
    "id": "CONVERSATION_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde inbox:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 conversation_not_found, already_muted · 429 çok sık istek

inbox.open_conversation

Konuşma başlat — Kanallarınızdan birinde biriyle konuşma başlatır.

Gereken izin inbox:write · veriyi değiştirir

• REST kısayolu: POST /api/v1/conversations
• Asıl adres: POST /api/v1/actions/inbox.open_conversation

Girdi