# Talkdesk

> Read account, contacts and agents, and manage outbound record lists and scheduled callbacks.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/talkdesk

## Actions

### Cancel callback

Cancel callback in Talkdesk.

**Inputs**

- Callback (`callback_id`, text, required): Callback id

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {}
}
```

### Create callback

Create callback in Talkdesk.

**Inputs**

- Interaction ID (`interaction_id`, text, required): Id of the interaction
- Caller ID (`caller_id`, text, required): The number that will be shown as the caller
- Time to call (`time_to_call`, date and time, required): The time the callback is scheduled
- Timezone (`timezone`, text, required): The timezone in which the callback is scheduled. One of: `Africa/Abidjan`, `Africa/Accra`, `Africa/Addis_Ababa` (Africa/addis ababa), `Africa/Algiers`, `Africa/Asmara`, `Africa/Asmera`, `Africa/Bamako`, `Africa/Bangui`, `Africa/Banjul`, `Africa/Bissau`, and 589 more.
- Assign type (`assign_type`, text, required): Describes what assign type is this related to. One of: `MYSELF_ONLY` (Myself only), `SPECIFIC_AGENT` (Specific agent), `SPECIFIC_QUEUE` (Specific queue), `MYSELF_IF_AVAILABLE` (Myself if available), `ANY_ELIGIBLE_AGENT` (Any eligible agent).
- From call type (`from_call_type`, text, required): Describes what call type is this related to. One of: `INBOUND`, `MANUAL_OUTBOUND` (Manual outbound), `PROACTIVE_OUTBOUND` (Proactive outbound), `API`.
- Dialing model (`dialing_model`, text, required): Describes what dialing model is this related to. One of: `PREDICTIVE`, `PREVIEW`.
- Phone number (`phone_number`, text, required): The phone number that is scheduled to be called
- Description (`description`, text): The callback note
- Agent IDs (`agent_ids`, list): Agent IDs.
- Queues (`queues`, list): Queues.

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "agents": [],
    "assign_type_v2": "MYSELF_ONLY",
    "callback_id": "example",
    "caller_id": "example",
    "campaign_id": "example",
    "channel_type": "VOICE",
    "dialing_model": "PREDICTIVE",
    "from_call_type": "INBOUND",
    "interaction_id": "example",
    "phone_number": "example",
    "queues": [],
    "record_extra_data": {},
    "record_first_name": "example",
    "record_id": "example",
    "record_last_name": "example",
    "record_list_id": "example",
    "time_to_call": "example",
    "timezone": "example"
  }
}
```

### Create record list

Create record list in Talkdesk.

**Inputs**

- Name (`name`, text, required): Name of the Record List

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "id": "example",
    "name": "example",
    "signed_url": "example",
    "status": "example",
    "unique_identifier_type": "example"
  }
}
```

### Create records

Create records in Talkdesk.

**Inputs**

- Record list (`record_list_id`, text, required): The identifier of the record list.
- Phone number (`phone_number`, text): Phone number of the record (required if phone_numbers field is not present)
- Phone numbers (`phone_numbers`, list, required): List of phone numbers of the record (required if phone_number field is not present)
- First name (`first_name`, text, required): First name of the record
- Last name (`last_name`, text, required): Last name of the record
- Timezone (`timezone`, text): Timezone of the record. One of: `Africa/Abidjan`, `Africa/Accra`, `Africa/Addis_Ababa` (Africa/addis ababa), `Africa/Algiers`, `Africa/Asmara`, `Africa/Asmera`, `Africa/Bamako`, `Africa/Bangui`, `Africa/Banjul`, `Africa/Bissau`, and 589 more.
- Priority (`priority`, number): Priority of the record within the record list. From 1 to 10.

**Outputs**

- `data` (object): Record object

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "created_at": "example",
    "external_id": "example",
    "external_provider": "example",
    "external_url": "example",
    "extra_data": {},
    "first_name": "example",
    "id": "example",
    "last_name": "example",
    "phone_number": "example",
    "phone_numbers": [],
    "priority": 1,
    "record_list_id": "example",
    "sync_external_id": false,
    "timezone": "example",
    "updated_at": "example"
  }
}
```

### Delete record

Delete record in Talkdesk.

**Inputs**

- Record list (`record_list_id`, text, required): The identifier of the record list.
- Record (`record_id`, text, required): Record id

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {}
}
```

### Get account

Get account in Talkdesk.

**Inputs**: None.

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example",
        "users": "example"
      }
    },
    "company_name": "example",
    "created_at": "example",
    "email": "example",
    "id": "example",
    "name": "example",
    "provisioned_at": "example",
    "timezone": "example"
  }
}
```

### Get callback

Get callback in Talkdesk.

**Inputs**

- Callback (`callback_id`, text, required): The identifier of the callback.

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "account_id": "example",
    "agents": [],
    "assign_type_v2": "MYSELF_ONLY",
    "callback_id": "example",
    "caller_id": "example",
    "campaign_id": "example",
    "channel_type": "VOICE",
    "contact_id": "example",
    "created_at": "example",
    "created_by": "example",
    "current_rescheduled_attempts": 1,
    "current_retry_attempts": 1,
    "dialing_model": "PREDICTIVE",
    "from_call_type": "INBOUND",
    "interaction_id": "example",
    "max_rescheduled_attempts": 1,
    "next_time_to_call": "example",
    "phone_number": "example",
    "preferred_end_time": "example",
    "preferred_start_time": "example",
    "processed_time": "example",
    "queues": [],
    "record_extra_data": {},
    "record_first_name": "example",
    "record_id": "example",
    "record_last_name": "example",
    "record_list_id": "example",
    "record_list_name": "example",
    "root_interaction_id": "example",
    "scheduled_time_to_call": "example",
    "status": "UNATTEMPTED,",
    "teams": [],
    "time_to_call": "example",
    "timezone": "example"
  }
}
```

### Get contact

Get contact in Talkdesk.

**Inputs**

- Contact (`contact_id`, text, required): The contact id

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "contact": {
      "_links": {
        "integrations": {
          "href": "example"
        },
        "self": {
          "href": "example"
        }
      },
      "company": "example",
      "emails": [],
      "id": "example",
      "name": "example",
      "phones": []
    }
  }
}
```

### Get record

Get record in Talkdesk.

**Inputs**

- Record list (`record_list_id`, text, required): The identifier of the record list.
- Record (`record_id`, text, required): Record id

**Outputs**

- `data` (object): Record object

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "created_at": "example",
    "external_id": "example",
    "external_provider": "example",
    "external_url": "example",
    "extra_data": {},
    "first_name": "example",
    "id": "example",
    "last_name": "example",
    "phone_number": "example",
    "phone_numbers": [],
    "priority": 1,
    "record_list_id": "example",
    "sync_external_id": false,
    "timezone": "example",
    "updated_at": "example"
  }
}
```

### Get record list

Get record list in Talkdesk.

**Inputs**

- Record list (`record_list_id`, text, required): The identifier of the record list.
- Fields (`fields`, text): Allows to request the sub entities of the record list teams -> Return the record list's teams information. One of: `TEAMS`.

**Outputs**

- `data` (object): Record list object.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "campaign_page": {
      "_embedded": {
        "campaigns": []
      },
      "_links": {
        "first": {
          "href": "example"
        },
        "last": {
          "href": "example"
        },
        "next": {
          "href": "example"
        },
        "prev": {
          "href": "example"
        },
        "self": {
          "href": "example"
        }
      },
      "count": 1,
      "page": 1,
      "per_page": 1,
      "total": 1,
      "total_pages": 1
    },
    "created_at": "example",
    "id": "example",
    "name": "example",
    "records_count": 1,
    "status": "REJECTED",
    "teams": [],
    "unique_identifier_type": "example",
    "updated_at": "example"
  }
}
```

### Get user

Get user in Talkdesk.

**Inputs**

- Agent (`agent_id`, text, required): The user id

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "active": false,
    "created_at": "example",
    "email": "example",
    "extension": 1,
    "external_phone_number": "example",
    "gender": "example",
    "id": "example",
    "name": "example"
  }
}
```

### Get user presence

Get user presence in Talkdesk.

**Inputs**

- Agent (`agent_id`, text, required): The user id

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "account_id": "example",
    "channels": [],
    "custom_status": "example",
    "custom_status_id": "example",
    "devices": [],
    "id": "example",
    "interactions": [],
    "occupancy": 1,
    "status": "available",
    "updated_at": "example",
    "updated_by": "example",
    "user_id": "example"
  }
}
```

### List callbacks

List callbacks in Talkdesk.

**Inputs**

- Page (`page`, number): page. From 1 to 500. Default: `1`.
- Per page (`per_page`, number): per page. From 1 to 500. Default: `1`.
- Phone number (`phone_number`, text): The phone number that is scheduled to be called.
- Contact (`contact_id`, text): The id of the contact that is scheduled to be called.
- Status (`status`, text): The status of callback

**Outputs**

- `data` (object): Talkdesk response data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": {
    "_embedded": {
      "callbacks": []
    },
    "_links": {
      "first": {
        "href": "example"
      },
      "last": {
        "href": "example"
      },
      "prev": {
        "href": "example"
      },
      "self": {
        "href": "example"
      }
    },
    "count": 1,
    "page": 1,
    "per_page": 1,
    "total": 1,
    "total_pages": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### List contact custom fields

List contact custom fields in Talkdesk.

**Inputs**

- Contact (`contact_id`, text, required): The contact id
- Page (`page`, number): Page. From 1 to 2147483647. Default: `1`.
- Per page (`per_page`, number): Per page. From 1 to 50. Default: `5`.
- Search (`search`, text): Search.

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "_embedded": {
      "custom_fields": []
    },
    "_links": {
      "next": {
        "href": "example"
      },
      "prev": {
        "href": "example"
      },
      "self": {
        "href": "example"
      }
    },
    "count": 1,
    "total": 1
  }
}
```

### List contacts

List contacts in Talkdesk.

**Inputs**

- Name (`name`, text): Filter by 'Contact full name'.
- Page (`page`, number): Requested page number. At least 1. Default: `1`.
- Per page (`per_page`, number): Number of elements per page. From 1 to 50. Default: `50`.

**Outputs**

- `data` (object): Talkdesk response data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": {
    "_embedded": {
      "contacts": []
    },
    "_links": {
      "next": {
        "href": "example"
      },
      "prev": {
        "href": "example"
      },
      "self": {
        "href": "example"
      }
    },
    "count": 1,
    "total": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### List record lists

List record lists in Talkdesk.

**Inputs**

- Name (`name`, text): Filter by record lists names,fuzzy query
- Status (`status`, text): Filter Record Lists by status
- Fields (`fields`, text): Allows to request the sub entities of the record list. teams -> Return the record list's teams information. One of: `TEAMS`.
- Page (`page`, number): Number of the page listed. From 1 to 2147483647. Default: `1`.
- Per page (`per_page`, number): Number of max items per page. From 1 to 500. Default: `50`.

**Outputs**

- `data` (object): List with the paginated samples.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": {
    "_embedded": {
      "record_lists": []
    },
    "_links": {
      "first": {
        "href": "example"
      },
      "last": {
        "href": "example"
      },
      "next": {
        "href": "example"
      },
      "prev": {
        "href": "example"
      },
      "self": {
        "href": "example"
      }
    },
    "count": 1,
    "page": 1,
    "per_page": 1,
    "total": 1,
    "total_pages": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### List records

List records in Talkdesk.

**Inputs**

- Record list (`record_list_id`, text, required): The identifier of the record list.
- Phone number (`phone_number`, text): Filter Records by phone number
- Page (`page`, number): number of the page listed. From 1 to 2147483647.
- Per page (`per_page`, number): Number of max items per page. From 1 to 500. Default: `50`.

**Outputs**

- `data` (object): List with the paginated samples.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": {
    "_embedded": {
      "records": []
    },
    "_links": {
      "first": {
        "href": "example"
      },
      "last": {
        "href": "example"
      },
      "next": {
        "href": "example"
      },
      "prev": {
        "href": "example"
      },
      "self": {
        "href": "example"
      }
    },
    "count": 1,
    "page": 1,
    "per_page": 1,
    "total_pages": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### List users

List users in Talkdesk.

**Inputs**

- Active (`active`, true/false): Filter users by activation status
- Email (`email`, text): Filter users with the given email
- Page (`page`, number): Page. At least 1. Default: `1`.
- Per page (`per_page`, number): Per page. From 1 to 200. Default: `20`.

**Outputs**

- `data` (object): Talkdesk response data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": {
    "_embedded": {
      "users": []
    },
    "_links": {
      "first": {
        "href": "example"
      },
      "index": {
        "href": "example",
        "templated": false
      },
      "last": {
        "href": "example"
      },
      "next": {
        "href": "example"
      },
      "self": {
        "href": "example"
      },
      "show": {
        "href": "example",
        "templated": false
      }
    },
    "count": 1,
    "page": 1,
    "per_page": 1,
    "total": 1,
    "total_pages": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### Update callback

Update callback in Talkdesk.

**Inputs**

- Callback (`callback_id`, text, required): Callback id
- Time to call (`time_to_call`, date and time): Time to call.
- Phone number (`phone_number`, text): Phone number.
- Timezone (`timezone`, text): Timezone. One of: `Africa/Abidjan`, `Africa/Accra`, `Africa/Addis_Ababa` (Africa/addis ababa), `Africa/Algiers`, `Africa/Asmara`, `Africa/Asmera`, `Africa/Bamako`, `Africa/Bangui`, `Africa/Banjul`, `Africa/Bissau`, and 589 more.

**Outputs**

- `data` (object): Talkdesk response data.

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "account_id": "example",
    "agents": [],
    "assign_type_v2": "MYSELF_ONLY",
    "callback_id": "example",
    "caller_id": "example",
    "campaign_id": "example",
    "contact_id": "example",
    "created_at": "example",
    "created_by": "example",
    "dialing_model": "PREDICTIVE",
    "from_call_type": "INBOUND",
    "interaction_id": "example",
    "next_time_to_call": "example",
    "phone_number": "example",
    "preferred_end_time": "example",
    "preferred_start_time": "example",
    "processed_time": "example",
    "queues": [],
    "record_extra_data": {},
    "record_first_name": "example",
    "record_id": "example",
    "record_last_name": "example",
    "record_list_id": "example",
    "root_interaction_id": "example",
    "scheduled_time_to_call": "example",
    "status": "UNATTEMPTED,",
    "teams": [],
    "timezone": "example"
  }
}
```

### Update record

Update record in Talkdesk.

**Inputs**

- Record list (`record_list_id`, text, required): The identifier of the record list.
- Record (`record_id`, text, required): Record id
- First name (`first_name`, text): First name.
- Last name (`last_name`, text): Last name.
- Priority (`priority`, number): Priority. From 1 to 10.
- Timezone (`timezone`, text): Timezone. One of: `Africa/Abidjan`, `Africa/Accra`, `Africa/Addis_Ababa` (Africa/addis ababa), `Africa/Algiers`, `Africa/Asmara`, `Africa/Asmera`, `Africa/Bamako`, `Africa/Bangui`, `Africa/Banjul`, `Africa/Bissau`, and 589 more.

**Outputs**

- `data` (object): Record object

**Example output**

```json
{
  "data": {
    "_links": {
      "self": {
        "href": "example"
      }
    },
    "created_at": "example",
    "external_id": "example",
    "external_provider": "example",
    "external_url": "example",
    "extra_data": {},
    "first_name": "example",
    "id": "example",
    "last_name": "example",
    "phone_number": "example",
    "phone_numbers": [],
    "priority": 1,
    "record_list_id": "example",
    "sync_external_id": false,
    "timezone": "example",
    "updated_at": "example"
  }
}
```
