Talkdesk

App · 20 actions

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

Actions

ActionWhat it does
Cancel callbackCancel callback in Talkdesk.
Create callbackCreate callback in Talkdesk.
Create record listCreate record list in Talkdesk.
Create recordsCreate records in Talkdesk.
Delete recordDelete record in Talkdesk.
Get accountGet account in Talkdesk.
Get callbackGet callback in Talkdesk.
Get contactGet contact in Talkdesk.
Get recordGet record in Talkdesk.
Get record listGet record list in Talkdesk.
Get userGet user in Talkdesk.
Get user presenceGet user presence in Talkdesk.
List callbacksList callbacks in Talkdesk.
List contact custom fieldsList contact custom fields in Talkdesk.
List contactsList contacts in Talkdesk.
List record listsList record lists in Talkdesk.
List recordsList records in Talkdesk.
List usersList users in Talkdesk.
Update callbackUpdate callback in Talkdesk.
Update recordUpdate record in Talkdesk.

Cancel callback

Cancel callback in Talkdesk.

Inputs

Callbackcallback_idtextRequired
Callback id

Outputs

dataobject
Talkdesk response data.
Example output
{
  "data": {}
}

Create callback

Create callback in Talkdesk.

Inputs

Interaction IDinteraction_idtextRequired
Id of the interaction
Caller IDcaller_idtextRequired
The number that will be shown as the caller
Time to calltime_to_calldate and timeRequired
The time the callback is scheduled
TimezonetimezonetextRequired
The timezone in which the callback is scheduledOne 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 typeassign_typetextRequired
Describes what assign type is this related toOne 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 typefrom_call_typetextRequired
Describes what call type is this related toOne of: INBOUND, MANUAL_OUTBOUND (Manual outbound), PROACTIVE_OUTBOUND (Proactive outbound), API.
Dialing modeldialing_modeltextRequired
Describes what dialing model is this related toOne of: PREDICTIVE, PREVIEW.
Phone numberphone_numbertextRequired
The phone number that is scheduled to be called
Descriptiondescriptiontext
The callback note
Agent IDsagent_idslist
Agent IDs.
Queuesqueueslist
Queues.

Outputs

dataobject
Talkdesk response data.
Example output
{
  "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

NamenametextRequired
Name of the Record List

Outputs

dataobject
Talkdesk response data.
Example output
{
  "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 listrecord_list_idtextRequired
The identifier of the record list.
Phone numberphone_numbertext
Phone number of the record (required if phone_numbers field is not present)
Phone numbersphone_numberslistRequired
List of phone numbers of the record (required if phone_number field is not present)
First namefirst_nametextRequired
First name of the record
Last namelast_nametextRequired
Last name of the record
Timezonetimezonetext
Timezone of the recordOne 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.
Priorityprioritynumber
Priority of the record within the record listFrom 1 to 10.

Outputs

dataobject
Record object
Example output
{
  "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 listrecord_list_idtextRequired
The identifier of the record list.
Recordrecord_idtextRequired
Record id

Outputs

dataobject
Talkdesk response data.
Example output
{
  "data": {}
}

Get account

Get account in Talkdesk.

Inputs

None.

Outputs

dataobject
Talkdesk response data.
Example output
{
  "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

Callbackcallback_idtextRequired
The identifier of the callback.

Outputs

dataobject
Talkdesk response data.
Example output
{
  "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

Contactcontact_idtextRequired
The contact id

Outputs

dataobject
Talkdesk response data.
Example output
{
  "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 listrecord_list_idtextRequired
The identifier of the record list.
Recordrecord_idtextRequired
Record id

Outputs

dataobject
Record object
Example output
{
  "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 listrecord_list_idtextRequired
The identifier of the record list.
Fieldsfieldstext
Allows to request the sub entities of the record list teams -> Return the record list's teams information.One of: TEAMS.

Outputs

dataobject
Record list object.
Example output
{
  "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

Agentagent_idtextRequired
The user id

Outputs

dataobject
Talkdesk response data.
Example output
{
  "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

Agentagent_idtextRequired
The user id

Outputs

dataobject
Talkdesk response data.
Example output
{
  "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

Pagepagenumber
pageFrom 1 to 500. Default: 1.
Per pageper_pagenumber
per pageFrom 1 to 500. Default: 1.
Phone numberphone_numbertext
The phone number that is scheduled to be called.
Contactcontact_idtext
The id of the contact that is scheduled to be called.
Statusstatustext
The status of callback

Outputs

dataobject
Talkdesk response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "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

Contactcontact_idtextRequired
The contact id
Pagepagenumber
Page.From 1 to 2147483647. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 50. Default: 5.
Searchsearchtext
Search.

Outputs

dataobject
Talkdesk response data.
Example output
{
  "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

Namenametext
Filter by 'Contact full name'.
Pagepagenumber
Requested page number.At least 1. Default: 1.
Per pageper_pagenumber
Number of elements per page.From 1 to 50. Default: 50.

Outputs

dataobject
Talkdesk response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "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

Namenametext
Filter by record lists names,fuzzy query
Statusstatustext
Filter Record Lists by status
Fieldsfieldstext
Allows to request the sub entities of the record list. teams -> Return the record list's teams information.One of: TEAMS.
Pagepagenumber
Number of the page listedFrom 1 to 2147483647. Default: 1.
Per pageper_pagenumber
Number of max items per pageFrom 1 to 500. Default: 50.

Outputs

dataobject
List with the paginated samples.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "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 listrecord_list_idtextRequired
The identifier of the record list.
Phone numberphone_numbertext
Filter Records by phone number
Pagepagenumber
number of the page listedFrom 1 to 2147483647.
Per pageper_pagenumber
Number of max items per pageFrom 1 to 500. Default: 50.

Outputs

dataobject
List with the paginated samples.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "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

Activeactivetrue/false
Filter users by activation status
Emailemailtext
Filter users with the given email
Pagepagenumber
Page.At least 1. Default: 1.
Per pageper_pagenumber
Per page.From 1 to 200. Default: 20.

Outputs

dataobject
Talkdesk response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "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

Callbackcallback_idtextRequired
Callback id
Time to calltime_to_calldate and time
Time to call.
Phone numberphone_numbertext
Phone number.
Timezonetimezonetext
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

dataobject
Talkdesk response data.
Example output
{
  "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 listrecord_list_idtextRequired
The identifier of the record list.
Recordrecord_idtextRequired
Record id
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Priorityprioritynumber
Priority.From 1 to 10.
Timezonetimezonetext
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

dataobject
Record object
Example output
{
  "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"
  }
}

On this page