Copy Page
Hatif
Rate Limiting
Account API
Service Login
Channels API
Get Channels
Support API
Upload Image, Video, or PDF
Upload Audio File
Whatsapp API
Send Text
Send Template
Send Image
Send Audio
Send Video
Send File
Send Interactive Buttons
List Templates (Service Account)
Contact
Set Property Value on Contact
Search Contacts
Delete Property Value on Contact
Create Contact
Update Contact
Get Contacts
Get Contact By Id
Create Bulk Contacts vCards
Contacts History
Contact Properties
List Contact Properties
Contact Properties Statistics
Create Contact Property
Update Contact Property
Delete Contact Property
Workspace API
Get Workspace Users
Conversations API
Get Conversation Timeline
List Conversations
Create Conversation
Assign Conversation
Get Conversation
Assign Conversation
Tags API
Tag a conversation
Create Tag
Delete Tag
Update Tag
List Tags
Outbound IVR
Create Outbound IVR
Get Outbound IVR Request
Outbound IVR Flows
Create Outbound IVR Flow
List Outbound IVR Flows
Get Outbound IVR Flow
Update Outbound IVR Flow
Delete Outbound IVR Flow
Tasks API
Create Task
List Tasks
Get Task
Update Task
Delete Task
List Task Properties
Create Task Property
List Task Projects
Create Task Project
Get Task Project
Rename Task Project
Delete Task Project
List Task Sections
Create Task Section
List Tasks By Conversation
Move Task
Schedule Task
Assign Task
Set Task Due Date
Complete Task
Reopen Task
Set Task Section
Move Task Project
Rename Task Section
Delete Task Section
Move Task Section
Update Task Property
Delete Task Property
Set Task Property Value
List Task Comments
Create Task Comment
Edit Task Comment
Delete Task Comment
Set Task Reminder
Teams API
Create Team
Get Team
Update Team
Delete Team
Add Team Members
Update Team Member Conversation Access
Remove Team Member
List Teams
List Team Member Options
List Team Assignment Targets
Assign Conversation to Team
Partner API
2. Register customer
1) Create registration
Update registration details
Resend mobile code
2) Verify mobile code
3) Send email code
4) Verify email code
5) Complete registration → workspace + workspace key
Issue another workspace key
3. Subscribe (plan & balance)
Add wallet balance (top-up) → payment link
Plans you can sell (find the Builder plan ID)
Get wallet balance
Create quote (plan) → payment link
Get quote status (poll for payment)
4. Phone number
Assign number (after payment)
Available numbers
List the workspace's channels
5. Contract
Replaced: use Get activation link
Replaced: number status is on the channel
Get activation link
6. AI agent (SIP)
Connect the number to your AI agent
Disconnect your AI agent
7. Calls & events
Not available yet: list calls
Not available yet: set events webhook
Call Webhook
WhatsApp Message Webhook
Schemas
Call Webhook
WhatsApp Message Webhook
ServiceAccountTemplateDto
OutboundIvrOption
ConversationDto
RegistrationDetails
CreateTagDto
AbpError
ServiceAccountTemplateParameterDto
OutboundIvrQuestionStepProps
ChannelConversationDto
UpdateTagDto
TaskPropertyValue
CreateRegistration
ServiceAccountCreateTaskDto
TemplateParameterDto
OutboundIvrStep
OtpCode
TagDto
PagedResultOfTagDto
TaskActivityPropertySnapshot
ConversationTimelineDto
ApiCredential
ParameterValueDto
CreateOutboundIvrRequest
TaskActivitySnapshot
SaveOutboundIvrFlow
ChannelNotFoundError
OutboundIvrFlow
Quote
AiSummaryDto
TaskActivityDto
ReplyInfoDto
OutboundIvrAnswer
TaskSummaryDto
InternalThreadDto
OutboundIvrStatus
TaskDto
LocationMessageDto
OutboundIvrResult
PagedResultOfTaskDto
AssignationInfoDto
TaskPropertyDefinitionDto
PagedResultOfConversationDto
OutboundIvrAudioType
OutboundIvrRequest
PagedResultOfConversationTimelineDto
TaskProjectDto
TaskSectionDto
OutboundIvrWebhookPayload
PagedResultOfTaskProjectDto
PagedResultOfTaskSectionDto
UpdateTaskDto
MoveTaskDto
SetTaskSectionDto
SetTaskScheduleDto
AssignTaskDto
SetTaskDueDateDto
NameDto
MoveBeforeDto
TaskPropertyOptionDto
CreateTaskPropertyDto
UpdateTaskPropertyDto
TaskCommentDto
WriteTaskCommentDto
PagedResultOfTaskCommentDto
SetTaskReminderDto
AiSummaryDto
Copy Page
AI-generated call summary
{
"Summary"
:
"string"
,
"Transcription"
:
"string"
}