Hipcall SDK API Reference

hipcall_sdk.client

class hipcall_sdk.client.AsyncClient(api_key, base_url=None)

Bases: HipcallBaseClient

async call_and_bridge(user_id, callee_number, ring_user_first=True)

Call and bridge user and given number.

Parameters:

• user_id (int) – Database ID of the caller user.

• callee_number (str) – Callee number.

• ring_user_first (bool) – Rings user first if set to True. Defaults to True.

Return type:

CallAndBridgeResponse

Returns:

Pydantic model containing call & bridge response.

async create_task(task)

Create new task on Hipcall.

Parameters:

task (TaskCreate) – Pydantic model containing data for Task creation.

Return type:

TaskResponse

Returns:

Pydantic model containing created task information.

async get_call(call_id, date)

Get call details for given call ID and date.

Parameters:

• call_id (str) – UUID of the call.

• date (str) – Date of the call.

Return type:

CallDetailResponse

Returns:

Pydantic model containing call details.

async get_calls(limit=10, offset=0, q=None, sort='started_at.asc')

Get list of calls with query.

Parameters:

• limit (int) – Limit of query. Min 1, Max 100. Defaults to 10.

• offset (int) – Offset of the query. Defaults to 0.

• q (Optional[str]) – Search query which is searched at caller_number and callee_number. Don’t add + or 00 as prefix just write number with country code.

• sort (str) – Sort parameter. Defaults to “started_at.asc”.

Return type:

CallListResponse

Returns:

Pydantic model containing call list and metadata.

async get_task(task_id)

Get task information by ID.

Parameters:

task_id (int) – Database ID of the task.

Return type:

TaskDetailResponse

Returns:

Pydantic model containing task information.

async get_tasks(limit=10, offset=0, q=None, sort='id.asc')

Get list of tasks with query.

Parameters:

• limit (int) – Limit of query. Min 1, Max 100. Defaults to 10.

• offset (int) – Offset of the query. Defaults to 0.

• q (Optional[str]) – Search query which is searched name of the task.

• sort (str) – Sort parameter. Defaults to “id.asc”. Supported fields: id and name Ordering options: asc, asc_nulls_last, asc_nulls_first, desc, desc_nulls_last, desc_nulls_first

Return type:

TaskListResponse

Returns:

Pydantic model containing task list and metadata.

class hipcall_sdk.client.Client(api_key, base_url=None)

Bases: HipcallBaseClient

call_and_bridge(user_id, callee_number, ring_user_first=True)

Call and bridge user and given number.

Parameters:

• user_id (int) – Database ID of the caller user.

• callee_number (str) – Callee number.

• ring_user_first (bool) – Rings user first if set to True. Defaults to True.

Return type:

CallAndBridgeResponse

Returns:

Pydantic model containing call & bridge response.

create_task(task)

Create new task on Hipcall.

Parameters:

task (TaskCreate) – Pydantic model containing data for Task creation.

Return type:

TaskResponse

Returns:

Pydantic model containing created task information.

get_call(call_id, date)

Get call details for given call ID and date.

Parameters:

• call_id (str) – UUID of the call.

• date (str) – Date of the call.

Return type:

CallDetailResponse

Returns:

Pydantic model containing call details.

get_calls(limit=10, offset=0, q=None, sort='started_at.desc')

Get list of calls with query.

Parameters:

• limit (int) – Limit of query. Min 1, Max 100. Defaults to 10.

• offset (int) – Offset of the query. Defaults to 0.

• q (Optional[str]) – Search query which is searched at caller_number and callee_number. Don’t add + or 00 as prefix just write number with country code.

• sort (str) – Sort parameter. Defaults to “started_at.asc”.

Return type:

CallListResponse

Returns:

Pydantic model containing call list and metadata.

get_task(task_id)

Get task information by ID.

Parameters:

task_id (int) – Database ID of the task.

Return type:

TaskDetailResponse

Returns:

Pydantic model containing task information.

get_tasks(limit=10, offset=0, q=None, sort='id.asc')

Get list of tasks with query.

Parameters:

• limit (int) – Limit of query. Min 1, Max 100. Defaults to 10.

• offset (int) – Offset of the query. Defaults to 0.

• q (Optional[str]) – Search query which is searched name of the task.

• sort (str) – Sort parameter. Defaults to “id.asc”. Supported fields: id and name Ordering options: asc, asc_nulls_last, asc_nulls_first, desc, desc_nulls_last, desc_nulls_first

Return type:

TaskListResponse

Returns:

Pydantic model containing task list and metadata.

hipcall_sdk.models

pydantic model hipcall_sdk.models.Call

Bases: BaseModel

Fields:

• answered_at (str | None)

• bridged_at (str | None)

• call_duration (int | None)

• direction (str)

• ended_at (str)

• first_touch_duration (int | None)

• missing_call (bool | None)

• started_at (str)

• uuid (str)

field answered_at: Optional[str] = None

field bridged_at: Optional[str] = None

field call_duration: Optional[int] = None

field direction: str [Required]

field ended_at: str [Required]

field first_touch_duration: Optional[int] = None

field missing_call: Optional[bool] = None

field started_at: str [Required]

field uuid: str [Required]

pydantic model hipcall_sdk.models.CallAndBridge

Bases: BaseModel

Fields:

• id (str)

field id: str [Required]

pydantic model hipcall_sdk.models.CallAndBridgeResponse

Bases: BaseModel

Fields:

• data (hipcall_sdk.models.CallAndBridge)

field data: CallAndBridge [Required]

pydantic model hipcall_sdk.models.CallDetail

Bases: BaseModel

Fields:

• answered_at (datetime.datetime | None)

• bridged_at (datetime.datetime | None)

• call_duration (int | None)

• call_flow (str | None)

• callback_cdr_uuid (str | None)

• callback_time (datetime.datetime | None)

• callback_user_id (int | None)

• callee_id (int | None)

• callee_number (str | None)

• callee_type (str | None)

• caller_id (int | None)

• caller_number (str | None)

• caller_type (str | None)

• channel_id (int | None)

• channel_type (str | None)

• contact_id (int | None)

• credited (bool | None)

• direction (str)

• ended_at (datetime.datetime)

• first_touch_duration (int | None)

• hangup_by (str | None)

• missing_call (bool | None)

• missing_call_reason (str | None)

• number_id (int | None)

• record_url (str | None)

• related_id (int | None)

• related_type (str | None)

• started_at (datetime.datetime)

• user_id (int | None)

• uuid (str)

• voicemail_id (int | None)

• voicemail_type (str | None)

• voicemail_url (str | None)

field answered_at: Optional[datetime] = None

field bridged_at: Optional[datetime] = None

field call_duration: Optional[int] = None

field call_flow: Optional[str] = None

field callback_cdr_uuid: Optional[str] = None

field callback_time: Optional[datetime] = None

field callback_user_id: Optional[int] = None

field callee_id: Optional[int] = None

field callee_number: Optional[str] = None

field callee_type: Optional[str] = None

field caller_id: Optional[int] = None

field caller_number: Optional[str] = None

field caller_type: Optional[str] = None

field channel_id: Optional[int] = None

field channel_type: Optional[str] = None

field contact_id: Optional[int] = None

field credited: Optional[bool] = None

field direction: str [Required]

field ended_at: datetime [Required]

field first_touch_duration: Optional[int] = None

field hangup_by: Optional[str] = None

field missing_call: Optional[bool] = None

field missing_call_reason: Optional[str] = None

field number_id: Optional[int] = None

field record_url: Optional[str] = None

field related_id: Optional[int] = None

field related_type: Optional[str] = None

field started_at: datetime [Required]

field user_id: Optional[int] = None

field uuid: str [Required]

field voicemail_id: Optional[int] = None

field voicemail_type: Optional[str] = None

field voicemail_url: Optional[str] = None

pydantic model hipcall_sdk.models.CallDetailResponse

Bases: BaseModel

Fields:

• data (hipcall_sdk.models.CallDetail)

field data: CallDetail [Required]

pydantic model hipcall_sdk.models.CallListResponse

Bases: BaseModel

Fields:

• data (List[hipcall_sdk.models.Call])

• meta (hipcall_sdk.models.Meta)

field data: List[Call] [Required]

field meta: Meta [Required]

pydantic model hipcall_sdk.models.Meta

Bases: BaseModel

Fields:

• count (int)

• limit (int)

• offset (int)

field count: int [Required]

field limit: int [Required]

field offset: int [Required]

pydantic model hipcall_sdk.models.Task

Bases: BaseModel

Fields:

• description (str | None)

• done (bool)

• done_at (datetime.datetime | None)

• id (int)

• name (str)

field description: Optional[str] = None

field done: bool [Required]

field done_at: Optional[datetime] = None

field id: int [Required]

field name: str [Required]

pydantic model hipcall_sdk.models.TaskCreate

Bases: BaseModel

Fields:

• assign_to_user_id (int | None)

• auto_assign_to_user (bool | None)

• company_ids (List[int] | None)

• contact_ids (List[int] | None)

• deal_ids (List[int] | None)

• description (str | None)

• due_date (datetime.datetime | None)

• name (str)

• priority (str | None)

• task_list_id (int | None)

field assign_to_user_id: Optional[int] = None

field auto_assign_to_user: Optional[bool] = None

field company_ids: Optional[List[int]] = None

field contact_ids: Optional[List[int]] = None

field deal_ids: Optional[List[int]] = None

field description: Optional[str] = None

field due_date: Optional[datetime] = None

field name: str [Required]

field priority: Optional[str] = None

field task_list_id: Optional[int] = None

pydantic model hipcall_sdk.models.TaskDetail

Bases: BaseModel

Fields:

• assign_to_user_id (int | None)

• auto_assign_to_user (bool | None)

• company_ids (List[int] | None)

• contact_ids (List[int] | None)

• deal_ids (List[int] | None)

• description (str | None)

• done (bool)

• done_at (datetime.datetime | None)

• due_date (datetime.datetime | None)

• id (int)

• name (str)

• priority (str | None)

• task_list_id (int | None)

field assign_to_user_id: Optional[int] = None

field auto_assign_to_user: Optional[bool] = None

field company_ids: Optional[List[int]] = None

field contact_ids: Optional[List[int]] = None

field deal_ids: Optional[List[int]] = None

field description: Optional[str] = None

field done: bool [Required]

field done_at: Optional[datetime] = None

field due_date: Optional[datetime] = None

field id: int [Required]

field name: str [Required]

field priority: Optional[str] = None

field task_list_id: Optional[int] = None

pydantic model hipcall_sdk.models.TaskDetailResponse

Bases: BaseModel

Fields:

• data (hipcall_sdk.models.TaskDetail)

field data: TaskDetail [Required]

pydantic model hipcall_sdk.models.TaskListResponse

Bases: BaseModel

Fields:

• data (List[hipcall_sdk.models.Task])

• meta (hipcall_sdk.models.Meta)

field data: List[Task] [Required]

field meta: Meta [Required]

pydantic model hipcall_sdk.models.TaskResponse

Bases: BaseModel

Fields:

• data (hipcall_sdk.models.Task)

field data: Task [Required]

hipcall_sdk.exceptions

exception hipcall_sdk.exceptions.BadRequestException(status_code, content)

Bases: HipcallAPIException

exception hipcall_sdk.exceptions.HipcallAPIException(status_code, content)

Bases: Exception

exception hipcall_sdk.exceptions.NotFoundException(status_code, content)

Bases: HipcallAPIException

exception hipcall_sdk.exceptions.UnauthorizedException(status_code, content)

Bases: HipcallAPIException

exception hipcall_sdk.exceptions.UnprocessableEntityException(status_code, content)

Bases: HipcallAPIException