Skip to main content

​
What can you do with it?

The Talkdesk API allows you to manage customer service operations by accessing user information, creating intent cards for customer support guidance, and managing various customer service workflows within your Talkdesk environment.

​
How to use it?

​
Basic Command Structure

/your-talkdesk-connection [action] [required-parameters] [optional-parameters]

​
Parameters

Required:
  • action - The action to perform (get_users, create_intent_card, etc.)
  • integrationId - Talkdesk integration ID from configuration
Optional:
  • title - Title for intent cards
  • language - Language code for content
  • page - Page number for paginated results
  • per_page - Number of results per page

​
Tools

​
Get Users

Retrieve a list of all users in your Talkdesk account. Parameters:
  • page (optional) - Page number (default: 1)
  • per_page (optional) - Results per page (default: 20)
Example: 
/your-talkdesk-connection
action: get_users
page: 1
per_page: 20
Response: 
{
  "total": 15,
  "count": 15,
  "page": 1,
  "per_page": 20,
  "total_pages": 1,
  "_embedded": {
    "users": [
      {
        "id": "123456789",
        "email": "user1@talkdesk.com",
        "name": "User1 Name",
        "active": true,
        "gender": "Male",
        "extension": null,
        "external_phone_number": "+123456789",
        "created_at": "2022-01-04T14:48:35Z",
        "_links": {
          "self": {
            "href": "https://api.talkdeskapp.com/users/123456789"
          }
        }
      }
    ]
  }
}

​
Create Intent Card Draft

Create a new draft intent card for customer support guidance. Parameters:
  • title (required) - Title of the intent card
  • language (required) - Language code (e.g., “en-us”)
  • content (optional) - Card content and attributes
Example: 
/your-talkdesk-connection
action: create_intent_card
title: Customer Billing Questions
language: en-us
content: Guide for handling billing-related customer inquiries
Response: 
{
  "id": "0ad52ae2-784c-4acd-8d78-8444a09b51e8",
  "title": "Customer Billing Questions",
  "language": "en-us",
  "version": "0.1",
  "active": true,
  "status": "ACTIVE",
  "tags": [],
  "edited_at": "2024-11-09T15:13:59Z",
  "edited_by": "system",
  "created_at": "2024-11-09T15:13:59Z",
  "created_by": "system",
  "metadata": [],
  "_links": {
    "self": {
      "href": "http://api.talkdeskapp.com/guide/intent-card/drafts"
    }
  }
}

​
Notes

Uses custom integration ID configuration. Supports user management and intent card creation for customer service workflows. Intent cards help guide agents through customer support scenarios and best practices
⌘I