atteq API
  • Guides
  • Recipes
  • Cookbook
  • API Reference
Information
agents
    List AgentsgetCreate AgentpostDocument AttachmentsgetGet VersiongetEdit DraftpatchReplace Draft GraphputPublish VersionpostGet AgentgetDelete AgentdeleteCopy AgentpostGet DraftgetGet Agent MapgetPending ChangesgetList PlacementsgetRestore VersionpostList VersionsgetGet Mapget
voice_agent
    Open Browser CallpostEnd Browser CalldeleteGet Agent Test LinkgetGet Bridge CeilinggetSet Bridge Ceilingpatch
ai_profiles
    Get Ai Profile CapabilitiesgetList Live SettingsgetCreate Live SettingspostDelete Live SettingsdeleteUpdate Live SettingspatchList Llm SettingsgetCreate Llm SettingspostDelete Llm SettingsdeleteUpdate Llm SettingspatchList ProfilesgetCreate ProfilepostGet ProfilegetDelete ProfiledeleteUpdate ProfilepatchCopy ProfilepostSet Text SectionputSet Voice SectionputList Stt SettingsgetCreate Stt SettingspostDelete Stt SettingsdeleteUpdate Stt SettingspatchList Tts SettingsgetCreate Tts SettingspostDelete Tts SettingsdeleteUpdate Tts SettingspatchList Vad SettingsgetCreate Vad SettingspostDelete Vad SettingsdeleteUpdate Vad Settingspatch
analyst
    List Agent FindingsgetCall Back FindingpostDismiss FindingpostUndo Finding DismissaldeleteTeach FindingpostWatch FindingpostList Question ChartsgetList Tracked QuestionsgetCreate Tracked QuestionpostGet Question Search CostgetSearch For Tracked QuestionpostPropose Tracked QuestionpostDelete Tracked QuestiondeleteUpdate Tracked QuestionpatchGet Reading SwitchgetSet Reading SwitchputGet Agent Summaryget
analytics
    List ChartsgetCreate ChartpostPreview ChartpostGet ChartgetDelete ChartdeleteUpdate ChartpatchRun ChartpostList DatasetsgetList BoardsgetCreate BoardpostGet TraversalgetGet BoardgetDelete BoarddeleteUpdate Boardpatch
authentication
    List InvitationsgetInvite MemberpostRevoke InvitationdeleteResend InvitationpostList MembersgetRemove MemberdeleteGet Member Conversation AccessgetSet Member Conversation AccesspatchSet Member FlagspatchSet Member RolepatchGet OrganizationgetUpdate OrganizationpatchGet Role FlagsgetSet Role Flagspatch
automations
    List AutomationsgetCreate AutomationpostGet AutomationgetDelete AutomationdeleteUpdate AutomationpatchSet Automation EnabledputGet Automation MapgetRun AutomationpostList Automation RunsgetGet Automation Runget
billable-metrics
    List MetricsgetUsage SummarygetGet Metricget
outbound_calls
    Place CallpostList CampaignsgetCreate CampaignpostGet CampaigngetDelete CampaigndeleteUpdate CampaignpatchActivate CampaignpostLink CollectionpostAdd ContactspostAdd Contacts From CollectionpostRemove Contacts From CollectionpostSet Campaign HoursputPreview Campaign HourspostPause CampaignpostGet Campaign SummarygetExclude ContactpostInclude Contactpost
channels
    List ChannelsgetCreate ChannelpostList Thread SubjectsgetClose Channel ThreadpostList Thread DecisionsgetGet Thread Contact FilegetHand Thread To AgentpostList Thread MailgetGet Prepared ReplygetAsk Again For Prepared ReplypostDiscard Prepared ReplypostSend Prepared ReplypostReply On Channel ThreadpostGet ChannelgetDelete ChanneldeleteUpdate ChannelpatchSend On ChannelpostList Channel ThreadsgetList RostergetCreate Roster EntrypostGet Own Roster EntrygetGet Roster EntrygetDelete Roster EntrydeleteUpdate Roster EntrypatchAdd Roster AddresspostChange Roster AddressputRemove Roster Addressdelete
custom-data
    List CollectionsgetCreate CollectionpostList Collection NamesgetGet CollectiongetDelete CollectiondeleteUpdate CollectionpatchAdd FieldpostDelete FielddeleteUpdate FieldpatchImport RecordspostPlan ImportpostPropose ImportpostGet ImportgetList RecordsgetCreate RecordpostBulk Delete RecordspostBulk Set FieldpostCount RecordsgetList Records Of ContactgetDelete Records Of ContactdeleteGet RecordgetDelete RecorddeleteUpdate Recordpatch
connections
    List ConnectionsgetCreate ConnectionpostCreate Forwarded AddresspostCreate Mail ServerpostDiscover Mail ServerpostAuthorize Microsoft MailboxpostList ProvidersgetGet ConnectiongetDelete ConnectiondeleteUpdate ConnectionpatchGet Forwarded AddressgetCheck Forwarded AddresspostList Person GrantsgetSet Person GrantputRemove Person GrantdeleteGet Mail ServergetUpdate Mail ServerpatchList Mail Server FoldersgetEnter Mail Server PasswordputChange Mail Server ServersputTest Mail Server AgainpostGet Microsoft MailboxgetUpdate Microsoft MailboxpatchList Microsoft Mailbox FoldersgetConsent To Microsoft Mailbox WritespostWithdraw Microsoft Mailbox Writesdelete
custom-tools
    List Custom ToolsgetCreate Custom ToolpostGet Custom ToolgetDelete Custom TooldeleteGet Custom Tool DraftgetEdit Custom Tool DraftpatchPublish Custom ToolpostRestore Custom Tool VersionpostTry Custom ToolpostList Custom Tool Versionsget
rag
    List DocumentsgetUpload DocumentpostSearch DocumentspostGet DocumentgetDelete DocumentdeleteDownload DocumentgetReingest Documentpost
flows
    List FlowsgetCreate FlowpostGet FlowgetDelete FlowdeleteRename FlowpatchAdd Flow EdgepostDelete Flow EdgedeleteSet Entry SteppatchAdd SteppostDelete StepdeleteUpdate SteppatchTest FlowpostList Flow Testsget
dynamic_context
    Create GraphpostGet GraphgetDelete GraphdeleteAdd EdgepostDelete EdgedeleteAdd NodepostDelete NodedeleteUpdate NodepatchSet Rootput
inbox
    Get Inbox Open CountgetSet Inbox PreferencespatchGet Inbox RailgetCreate Inbox ViewpostDelete Inbox ViewdeleteUpdate Inbox Viewpatch
handoff
    Assign Threadpost
interactions
    List InteractionsgetCount InteractionsgetGet InteractiongetSet Conversation LabelspostGet TracegetGet TranscriptgetList LabelsgetCreate LabelpostDelete LabeldeleteUpdate Labelpatch
legal
    Agree To Processing AgreementpostAgree To TermspostLegal BoxesgetList Legal DocumentsgetRead Legal DocumentgetList Legal VersionsgetRead Legal VersiongetDownload Legal VersiongetOrganization Legal HistorygetOwn Legal HistorygetObject To SubprocessorspostWithdraw ObjectionpostLegal Pendingget
not-a-tool
    Agree To Processing AgreementpostAgree To TermspostObject To SubprocessorspostWithdraw Objectionpost
memory
    List MemoriesgetList Memory LinesgetCreate Memory LinepostDelete Memory LinedeleteUpdate Memory LinepatchList Memory PeoplegetGet Memory PersongetForget PersondeleteGet Memory SwitchgetSet Memory SwitchputWipe ContactdeleteGet Conversation MemorygetRecall MemoriespostGet MemorygetDelete MemorydeletePatch Memorypatch
notifications
    List InboxgetGet Unread CountgetMark ReadpostMark Unreaddelete
recipes
    List RecipesgetList Installed RecipesgetGet Installed RecipegetUninstall RecipedeleteSet Recipe EnabledputUpdate Recipe ParameterspatchUpdate RecipepostInstall Recipepost
data-retention
    Get RetentiongetSet Retentionpatch
text
    Open ConversationpostClose ConversationpostAnswer ConfirmationpostGet Sent FilegetSend MessagepostSet Modepatch
tools
    List ToolsgetCreate ToolpostList BuiltinsgetImport Mcp ServerpostImport OpenapipostPreview Openapi ImportpostSuggest Tool ExamplespostGet ToolgetDelete TooldeleteUpdate ToolpatchTest ToolpostList Tool Testsget
trunks
    List Transfer DirectorygetCreate Transfer Directory EntrypostGet Transfer Directory EntrygetDelete Transfer Directory EntrydeleteUpdate Transfer Directory EntrypatchList TrunksgetCreate TrunkpostGet TrunkgetDelete TrunkdeleteUpdate TrunkpatchList Forward Recordsget
Schemas
powered by Zudoku
attek API
attek API

handoff


Assign Thread

POST
/api/v1/inbox/{interaction_id}/assign

Give an open conversation to a member, whoever holds it or nobody: it is then theirs as if they had taken it, and its agent stays silent. Assigning it to yourself takes it. 422 when the member could not open it -- not a member, without the inbox flag, or without access to its channel, said which; 409 when it has ended. Sent as take_thread sends it.

Assign Thread › path Parameters

interaction_id
​string · uuid · required

Assign Thread › Request Body

Who the thread is given to (handoff.md rule 23): a member of the organization, by person id — the id the member list and the record's `held_by_person_id` use.
AssignIn
person_id
​string · uuid · required

Assign Thread › Responses

Successful Response

One conversation, as the log shows it.
InteractionOut
channel
​Channel · enum · required

Voice and text are two channels over one graph, not two kinds of record.

Enum values:
voice
text
direction
​backend__features__interactions__schemas__Direction · enum · required
Enum values:
inbound
outbound
id
​string · uuid · required
is_open
​boolean · required
org_id
​string · uuid · required
​RunSettings · required

The settings a conversation actually ran with, copied in as values.

An AI profile is not frozen into an agent's published version, so the version alone cannot say how a conversation sounded. The profile id is kept for provenance; the provider, model and voice are kept because they are the answer. used_standby records that a standby served the conversation instead of some component's first choice — the same fields still describe what was actually served — and standby_component names which one switched.

​backend__features__interactions__schemas__Source · required

Source attribution, as recorded. kind says which of the rest is meaningful; the others stay unset.

connection_id and address are CHANNEL's pair, and they are two fields for the reason the thread itself is identified by two: "Threads are per connection; contacts are per organization" (channels.md). The connection says which of the organization's accounts the message arrived on — "reply on this thread has to know which account it leaves by" — and the address says who wrote, in whatever shape the provider's own namespace has: a phone number in E.164 on WhatsApp, an opaque user id elsewhere, "decided when each is built".

address is personal data and connection_id is not. The address is the contact — "on a channel, the contact is their address" — so the retention purge clears it exactly as it clears number, which is the same datum arriving by a different road; the connection names one of the organization's own accounts and survives, like trunk_id beside it.

provider is CHANNEL's third, and it is stored as a value rather than read off the connection. interactions.md: "a conversation that arrived on a channel names the provider it arrived on, beside the contact's address", because an address alone does not say whether the person was reached on WhatsApp, by mail or somewhere else. It is written by the channel at open, from the provider it is already speaking to, for the reason the run settings beside it are values too: a connection is what it is now, and this answers what the conversation arrived on then. It also keeps connection_id the opaque reference it is — nothing here dereferences a connection to render a row. Not personal data: it names a kind of account of the organization's own and nobody outside it, so it survives the purge exactly as connection_id does.

started_at
​string · date-time · required
​
​
​
​
​
channel_key
​string
Default:
contact_spoke
​boolean
Default: false
​
​
​
draft_test
​boolean
Default: false
​
​
​
​
​
​
​
label_ids
​string[]
​
​
​
​
​
​
​
rang
​boolean
Default: false
​
​
​
​
unreplied
​boolean
Default: false
​object
POST/api/v1/inbox/{interaction_id}/assign
curl /api/v1/inbox/:interaction_id/assign \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "person_id": "00000000-0000-0000-0000-000000000000" }'
Example Request Body
{ "person_id": "00000000-0000-0000-0000-000000000000" }
json
Example Responses
{ "agent_id": "00000000-0000-0000-0000-000000000000", "agent_version_id": "00000000-0000-0000-0000-000000000000", "answered_at": "2024-08-25T15:00:00Z", "answered_by": "person", "bridge_seconds": 0, "channel": "voice", "channel_key": "", "contact_spoke": false, "content_purged_at": "2024-08-25T15:00:00Z", "cuts": { "backchannel": 0, "before_line": 0, "confirmed_by_duration": 0, "confirmed_by_words": 0, "cuts": 0, "empty": 0, "overtaken": 0, "phantom": 0, "proposed": 0, "resumed": 0, "withdrawn": 0, "withdrawn_by_budget": 0 }, "direction": "inbound", "disconnect_reason": "string", "draft_test": false, "duration_seconds": 0, "end_reason": "string", "ended_at": "2024-08-25T15:00:00Z", "handoff_reason": "string", "handoff_reason_code": "kept_for_people", "held_by_person_id": "00000000-0000-0000-0000-000000000000", "hung_up_by": "contact", "id": "00000000-0000-0000-0000-000000000000", "is_open": true, "label_ids": [ "00000000-0000-0000-0000-000000000000" ], "last_activity_at": "2024-08-25T15:00:00Z", "last_line": { "actor_person_id": "00000000-0000-0000-0000-000000000000", "at": "2024-08-25T15:00:00Z", "speaker": "agent", "text": "text" }, "org_id": "00000000-0000-0000-0000-000000000000", "person_state": "waiting", "person_state_since": "2024-08-25T15:00:00Z", "pickup": { "decided_by": "classifier", "duration_ms": 0, "model": "string", "path": "spoke", "provider": "string" }, "prepared_outdated_by": "contact", "prepared_reply": "ready", "rang": false, "recording_duration_seconds": 0, "recording_size_bytes": 0, "recording_url": "string", "settings": { "ai_profile_id": "00000000-0000-0000-0000-000000000000", "arrangement_attempts": [], "arrangement_kind": "string", "arrangement_position": 0, "live_model": "string", "live_provider": "string", "live_resumptions": 0, "live_thinking": "string", "live_voice": "string", "llm_model": "string", "llm_provider": "string", "llm_thinking": "string", "standby_component": "llm", "stt_model": "string", "stt_provider": "string", "tts_provider": "string", "tts_voice": "string", "used_standby": false }, "source": { "address": "string", "api_key_id": "00000000-0000-0000-0000-000000000000", "campaign_id": "00000000-0000-0000-0000-000000000000", "connected_app_id": "00000000-0000-0000-0000-000000000000", "connection_id": "00000000-0000-0000-0000-000000000000", "context": { "key": "string" }, "kind": "inbound_number", "number": "string", "provider": "string", "trunk_id": "00000000-0000-0000-0000-000000000000", "wanted": "string", "widget": "string" }, "started_at": "2024-08-25T15:00:00Z", "transfer_outcome": "handed_over", "unreplied": false, "usage": { "key": "string" } }
json
application/json

inboxinteractions