Transcript API

URL

The API follows REST conventions. Perform an HTTPS GET to the URL with the format in which you’d like to receive data. The following response formats are supported, where CUID-33 is the call record id.

Format	Description and URL
json (default)	Returns a JSON array of the transcript. `https://mynetwork.invoca.net/call/transcript/CUID-33?transcript_format=agent`

Authentication

The API uses OAuth to validate access. Pass the OAuth Token in the Authorization header of the request. The OAuth Token is required. OAuth Tokens may be generated from the Manage API Credentials page.

Query Parameters

The API takes the following optional query parameters:

Parameter	Description
transcript_format= (required)	Determines what format the transcripts are returned as, see response parameters below for information on each format.

Response

Endpoint: https://mynetwork.invoca.net/call/transcript/<call_record_id>?transcript_format=<format>

GET /call/transcript/<call_record_id>?transcript_format=caller

Get a transcript of the call for just the caller.

Examples

Get transcript for the given call record CUID-33 with just the caller included Endpoint: https://mynetwork.invoca.net/call/transcript/CUID-33?transcript_format=caller Format: application/json Response Code: 200 Response Body:

[
  {
    "caller": "Orange, Awesome thank you, Have a good one"
  }
]

GET /call/transcript/<call_record_id>?transcript_format=agent

Get a transcript of the call for just the agent.

Examples

Get transcript for the given call record CUID-33 with just the agent included Endpoint: https://mynetwork.invoca.net/call/transcript/CUID-33?transcript_format=agent Format: application/json Response Code: 200 Response Body:

[
  {
    "agent": "Which Color?, Okay I will look into that, Goodbye!"
  }
]

GET /call/transcript/<call_record_id>?transcript_format=caller_agent_block

Get a transcript of the call as a block.

Examples

Get transcript for the given call record CUID-33 with both agent and caller included in a single block for each. Endpoint: https://mynetwork.invoca.net/call/transcript/CUID-33?transcript_format=caller_agent_block Format: application/json Response Code: 200 Response Body:

[
  { "agent": "Which Color?, Okay I will look into that, Goodbye!" },
  { "caller": "Orange, Awesome thank you, Have a good one" }
]

GET /call/transcript/<call_record_id>?transcript_format=caller_agent_conversation

Get a transcript of the call as a conversation.

Examples

Get transcript for the given call record CUID-33 with both agent and caller included in the corresponding conversation order. Endpoint: https://mynetwork.invoca.net/call/transcript/CUID-33?transcript_format=caller_agent_conversation Format: application/json Response Code: 200 Response Body:

[
  { "agent": "Which Color?" },
  { "caller": "Orange" },
  { "agent": "Okay I will look into that" },
  { "caller": "Awesome thank you" },
  { "agent": "Goodbye!" },
  { "caller": "Have a good one" }
]

​URL

​Authentication

​Query Parameters

​Response

​GET /call/transcript/<call_record_id>?transcript_format=caller

​Examples

​GET /call/transcript/<call_record_id>?transcript_format=agent

​Examples

​GET /call/transcript/<call_record_id>?transcript_format=caller_agent_block

​Examples

​GET /call/transcript/<call_record_id>?transcript_format=caller_agent_conversation

​Examples

URL

Authentication

Query Parameters

Response

GET /call/transcript/<call_record_id>?transcript_format=caller

Examples

GET /call/transcript/<call_record_id>?transcript_format=agent

Examples

GET /call/transcript/<call_record_id>?transcript_format=caller_agent_block

Examples

GET /call/transcript/<call_record_id>?transcript_format=caller_agent_conversation

Examples