# KrispCall

> Manage contacts, read call and message history, send SMS, and inspect workspace members, numbers, and webhook subscriptions.

App · 22 actions. Web page: https://docs.lodol.com/docs/integrations/krispcall

## Actions

### Create contact

Create Contact.

**Inputs**

- Contact (`contact`, text, required): Contact.
- Country (`country`, text): Country. Default: `US`.
- Name (`name`, text): Name.
- Email (`email`, text): Email.
- Company (`company`, text): Company.
- Address (`address`, text): Address.
- Tags (`tags`, list): Tags.
- Secondary phone (`secondary_phone`, list): Secondary phone.
- Secondary email (`secondary_email`, list): Secondary email.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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 (`entity`, text, required): Entity. One of: `call`, `sms`, `contact`.
- Event type (`event_type`, text, required): Event type. One 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_url`, text, required): An HTTPS address that receives the event.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": {
      "message": "example",
      "webhook_id": "example"
    },
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### Delete contact

Delete Contact.

**Inputs**

- ID (`id`, text, required): Id

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": "example",
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### Get blocked contact

Get Block Contact Details.

**Inputs**

- ID (`id`, text, required): Id

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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 (`id`, text, required): Id

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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 (`id`, text, required): Id

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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_id`, text, required): Dnd id

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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 (`id`, text, required): Id

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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 (`id`, text, required): Id

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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 (`number`, text, required): Number
- Country code (`country_code`, text): Country code. Default: `US`.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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_id`, text, required): Webhook id

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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 (`page`, number): Page. At least 1. Default: `1`.
- Size (`size`, number): Size. At least 1. Default: `10`.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### List calls

Get Calls.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Size (`size`, number): Size. From 1 to 500. Default: `25`.
- From date (`from_date`, date and time): From date
- To date (`to_date`, date and time): To date
- Other phone number (`number`, text, required): The phone number at the other end of the conversation, in international format.
- KrispCall number (`kc_number`, text, required): Your KrispCall phone number in international format.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### List contacts

Get All Contacts.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Size (`size`, number): Size. At least 1. Default: `25`.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### List do not disturb contacts

Get All Contact Dns.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Size (`size`, number): Size. At least 1. Default: `10`.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### List members

Get Members.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Size (`size`, number): Size. At least 1. Default: `25`.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### List messages

Get All Sms.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Size (`size`, number): Size. From 1 to 500. Default: `25`.
- From date (`from_date`, date and time): From date
- To date (`to_date`, date and time): To date
- Other phone number (`number`, text, required): The phone number at the other end of the conversation, in international format.
- KrispCall number (`kc_number`, text, required): Your KrispCall phone number in international format.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### List number messages

Get Sms By Number.

**Inputs**

- KrispCall number (`kc_number`, text, required): Your KrispCall phone number in international format.
- Page (`page`, number): Page. At least 1. Default: `1`.
- Size (`size`, number): Size. From 1 to 500. Default: `25`.
- Order by (`order_by`, text): Order by. One of: `asc`, `desc`. Default: `desc`.
- From date (`from_date`, date and time): From date
- To date (`to_date`, date and time): To date
- Direction (`direction`, text): Direction. One of: `Incoming`, `Outgoing`.
- Conversation status (`conversation_status`, text): Conversation status. One of: `Pending`, `Sent`, `Delivered`, `Failed`, `InProgress`, `Attempted`, `Rejected`.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "page": 1,
      "size": 1,
      "total_count": 1
    }
  }
}
```

### List numbers

Get All Numbers.

**Inputs**

- Page (`page`, number): Page. At least 1. Default: `1`.
- Size (`size`, number): Size. At least 1. Default: `25`.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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_number`, text, required): To number.
- From number (`from_number`, text, required): From number.
- Content (`content`, text, required): Content.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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 (`id`, text, required): Id
- Contact (`contact`, text): Contact.
- Country (`country`, text): Country.
- Name (`name`, text): Name.
- Email (`email`, text): Email.
- Company (`company`, text): Company.
- Address (`address`, text): Address.
- Tags (`tags`, list): Tags.
- Secondary phone (`secondary_phone`, list): Secondary phone.
- Secondary email (`secondary_email`, list): Secondary email.

**Outputs**

- `data` (object): The result returned by KrispCall.

**Example output**

```json
{
  "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
    }
  }
}
```
