Chilkat Online Tools

Objective-C / Support API / Open Ticket in Agent's Browser

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";

[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequest: @"POST" url: @"https://example.zendesk.com/api/v2/channels/voice/agents/:agent_id/tickets/:ticket_id/display"];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

Curl Command

curl  -u login:password -X POST
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/channels/voice/agents/:agent_id/tickets/:ticket_id/display

Postman Collection Item JSON

{
  "name": "Open Ticket in Agent's Browser",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/tickets/:ticket_id/display",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "channels",
        "voice",
        "agents",
        ":agent_id",
        "tickets",
        ":ticket_id",
        "display"
      ],
      "variable": [
        {
          "key": "agent_id",
          "value": "<integer>"
        },
        {
          "key": "ticket_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Allows you to instruct an agent's browser to open a ticket.\n\nWhen the message is successfully delivered to an agent's browser:\n\n```http\nStatus: 200 OK\n```\n\nWhen `agent_id` or `ticket_id` is invalid:\n\n```http\nStatus: 404 Not Found\n```\n\n#### Allowed For\n* Agents"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/tickets/:ticket_id/display",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "channels",
            "voice",
            "agents",
            ":agent_id",
            "tickets",
            ":ticket_id",
            "display"
          ],
          "variable": [
            {
              "key": "agent_id"
            },
            {
              "key": "ticket_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "<string>"
    },
    {
      "name": "When the `agent_id` or `ticket_id` is invalid",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/channels/voice/agents/:agent_id/tickets/:ticket_id/display",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "channels",
            "voice",
            "agents",
            ":agent_id",
            "tickets",
            ":ticket_id",
            "display"
          ],
          "variable": [
            {
              "key": "agent_id"
            },
            {
              "key": "ticket_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "<string>"
    }
  ]
}