KrispCall
App · 22 actions
Manage contacts, read call and message history, send SMS, and inspect workspace members, numbers, and webhook subscriptions.
Actions
| Action | What it does |
|---|---|
| Create contact | Create Contact. |
| Create webhook | Receive Webhook Event. |
| Delete contact | Delete Contact. |
| Get blocked contact | Get Block Contact Details. |
| Get call | Get Call. |
| Get contact | Get Contact. |
| Get do not disturb contact | Get Details. |
| Get member | Get Member. |
| Get message | Get Sms. |
| Get number | Get Number. |
| Get webhook | Get Webhook By Id. |
| Get workspace | Get Workspace. |
| List blocked contacts | Get Contact Block List. |
| List calls | Get Calls. |
| List contacts | Get All Contacts. |
| List do not disturb contacts | Get All Contact Dns. |
| List members | Get Members. |
| List messages | Get All Sms. |
| List number messages | Get Sms By Number. |
| List numbers | Get All Numbers. |
| Send SMS | Send a text message from a workspace number. |
| Update contact | Update Contact. |
Create contact
Create Contact.
Inputs
- Contact
contacttextRequired - Contact.
- Country
countrytext - Country.Default:
US. - Name
nametext - Name.
- Email
emailtext - Email.
- Company
companytext - Company.
- Address
addresstext - Address.
- Tags
tagslist - Tags.
- Secondary phone
secondary_phonelist - Secondary phone.
- Secondary email
secondary_emaillist - Secondary email.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"address": "example",
"blocked": false,
"blocked_by": "example",
"client_id": "example",
"company": "example",
"contact": "example",
"created_at": "example",
"created_by": "example",
"email": "example",
"favourite": false,
"id": "example",
"mark_as_read": false,
"modified_at": "example",
"name": "example",
"secondary_email": [],
"secondary_phone": [],
"status": "example",
"tags": [],
"visibility": false,
"workspace_id": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Create webhook
Receive Webhook Event.
Inputs
- Entity
entitytextRequired - EntityOne of:
call,sms,contact. - Event type
event_typetextRequired - Event typeOne of:
new_voicemail(New voicemail),new_call_log(New call log),new_sms_or_mms(New sms or mms),outbound_sms_or_mms(Outbound sms or mms),new_contact(New contact),remove_contact(Remove contact),updated_contact(Updated contact). - Webhook URL
webhook_urltextRequired - An HTTPS address that receives the event.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"message": "example",
"webhook_id": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Delete contact
Delete Contact.
Inputs
- ID
idtextRequired - Id
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": "example",
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get blocked contact
Get Block Contact Details.
Inputs
- ID
idtextRequired - Id
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"channels": {
"blocked": false,
"country": "example",
"created_at": "example",
"modified_at": "example",
"number": "example",
"settings": "example"
},
"contact": {
"address": "example",
"blocked": false,
"blocked_by": "example",
"client_id": "example",
"company": "example",
"contact": "example",
"created_at": "example",
"created_by": "example",
"email": "example",
"favourite": false,
"id": "example",
"mark_as_read": false,
"modified_at": "example",
"name": "example",
"secondary_email": [],
"secondary_phone": [],
"status": "example",
"tags": [],
"visibility": false,
"workspace_id": "example"
}
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get call
Get Call.
Inputs
- ID
idtextRequired - Id
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"agent_id": "example",
"call_info": {},
"call_type": "example",
"conversation_status": "example",
"created_date": "example",
"direction": "example",
"duration": "example",
"id": "example",
"krispcall_number": "example",
"modified_date": "example",
"notes": [],
"rating": 1,
"recording": "example",
"sid": "example",
"status": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get contact
Get Contact.
Inputs
- ID
idtextRequired - Id
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"address": "example",
"blocked": false,
"blocked_by": "example",
"client_id": "example",
"company": "example",
"contact": "example",
"created_at": "example",
"created_by": "example",
"email": "example",
"favourite": false,
"id": "example",
"mark_as_read": false,
"modified_at": "example",
"name": "example",
"secondary_email": [],
"secondary_phone": [],
"status": "example",
"tags": [],
"visibility": false,
"workspace_id": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get do not disturb contact
Get Details.
Inputs
- Dnd ID
dnd_idtextRequired - Dnd id
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"agent_id": "example",
"client": {
"channels": {
"blocked": false,
"country": "example",
"created_at": "example",
"modified_at": "example",
"number": "example",
"settings": "example"
},
"contact": {
"address": "example",
"blocked": false,
"blocked_by": "example",
"client_id": "example",
"company": "example",
"contact": "example",
"created_at": "example",
"created_by": "example",
"email": "example",
"favourite": false,
"id": "example",
"mark_as_read": false,
"modified_at": "example",
"name": "example",
"secondary_email": [],
"secondary_phone": [],
"status": "example",
"tags": [],
"visibility": false,
"workspace_id": "example"
}
},
"client_id": "example",
"dnd_duration": 1,
"dnd_enabled": false,
"dnd_endtime": "example",
"id": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get member
Get Member.
Inputs
- ID
idtextRequired - Id
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"date_of_birth": "example",
"email": "example",
"first_name": "example",
"gender": "example",
"id": "example",
"last_name": "example",
"workspace": {
"account_info": {
"is_owner": false,
"organization_agent": {},
"organization_id": {},
"owner_id": {}
},
"id": "example",
"kyc_verified": false,
"name": "example",
"status": "example",
"title": "example"
}
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get message
Get Sms.
Inputs
- ID
idtextRequired - Id
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"agent_id": "example",
"conversation_status": "example",
"created_date": "example",
"direction": "example",
"id": "example",
"krispcall_number": "example",
"modified_date": "example",
"number": "example",
"rating": "example",
"sid": "example",
"sms_info": {
"body": {},
"transcript": "example",
"transfered_audio": "example"
},
"sms_type": "example",
"status": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get number
Get Number.
Inputs
- Number
numbertextRequired - Number
- Country code
country_codetext - Country codeDefault:
US.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"abilities": {
"call": false,
"mms": false,
"sms": false,
"voicemail": false
},
"agent_id": "example",
"country_code": "example",
"extension": "example",
"id": "example",
"is_shared": false,
"name": "example",
"number": "example",
"number_type": "example",
"status": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get webhook
Get Webhook By Id.
Inputs
- Webhook ID
webhook_idtextRequired - Webhook id
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"client_id": "example",
"entity": "example",
"status": "active",
"types": "example",
"user_info": {},
"webhook_url": "example",
"workspace_id": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Get workspace
Get Workspace.
Inputs
None.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"account_info": {
"is_owner": false,
"organization_agent": "example",
"organization_id": "example",
"owner_id": "example"
},
"id": "example",
"kyc_verified": false,
"name": "example",
"status": "example",
"title": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}List blocked contacts
Get Contact Block List.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Size
sizenumber - SizeAt least 1. Default:
10.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": [],
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}List calls
Get Calls.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Size
sizenumber - SizeFrom 1 to 500. Default:
25. - From date
from_datedate and time - From date
- To date
to_datedate and time - To date
- Other phone number
numbertextRequired - The phone number at the other end of the conversation, in international format.
- KrispCall number
kc_numbertextRequired - Your KrispCall phone number in international format.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": [],
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}List contacts
Get All Contacts.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Size
sizenumber - SizeAt least 1. Default:
25.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": [],
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}List do not disturb contacts
Get All Contact Dns.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Size
sizenumber - SizeAt least 1. Default:
10.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": [],
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}List members
Get Members.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Size
sizenumber - SizeAt least 1. Default:
25.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": [],
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}List messages
Get All Sms.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Size
sizenumber - SizeFrom 1 to 500. Default:
25. - From date
from_datedate and time - From date
- To date
to_datedate and time - To date
- Other phone number
numbertextRequired - The phone number at the other end of the conversation, in international format.
- KrispCall number
kc_numbertextRequired - Your KrispCall phone number in international format.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": [],
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}List number messages
Get Sms By Number.
Inputs
- KrispCall number
kc_numbertextRequired - Your KrispCall phone number in international format.
- Page
pagenumber - PageAt least 1. Default:
1. - Size
sizenumber - SizeFrom 1 to 500. Default:
25. - Order by
order_bytext - Order byOne of:
asc,desc. Default:desc. - From date
from_datedate and time - From date
- To date
to_datedate and time - To date
- Direction
directiontext - DirectionOne of:
Incoming,Outgoing. - Conversation status
conversation_statustext - Conversation statusOne of:
Pending,Sent,Delivered,Failed,InProgress,Attempted,Rejected.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": [],
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}List numbers
Get All Numbers.
Inputs
- Page
pagenumber - PageAt least 1. Default:
1. - Size
sizenumber - SizeAt least 1. Default:
25.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": [],
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Send SMS
Send a text message from a workspace number. Uses your KrispCall balance.
Inputs
- To number
to_numbertextRequired - To number.
- From number
from_numbertextRequired - From number.
- Content
contenttextRequired - Content.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"content": "example",
"from_number": "example",
"medias": [],
"to_number": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}Update contact
Update Contact.
Inputs
- ID
idtextRequired - Id
- Contact
contacttext - Contact.
- Country
countrytext - Country.
- Name
nametext - Name.
- Email
emailtext - Email.
- Company
companytext - Company.
- Address
addresstext - Address.
- Tags
tagslist - Tags.
- Secondary phone
secondary_phonelist - Secondary phone.
- Secondary email
secondary_emaillist - Secondary email.
Outputs
dataobject- The result returned by KrispCall.
Example output
{
"data": {
"data": {
"address": "example",
"blocked": false,
"blocked_by": "example",
"client_id": "example",
"company": "example",
"contact": "example",
"created_at": "example",
"created_by": "example",
"email": "example",
"favourite": false,
"id": "example",
"mark_as_read": false,
"modified_at": "example",
"name": "example",
"secondary_email": [],
"secondary_phone": [],
"status": "example",
"tags": [],
"visibility": false,
"workspace_id": "example"
},
"metadata": {
"page": 1,
"size": 1,
"total_count": 1
}
}
}