Chilkat Online Tools

Objective-C / Sunshine Conversations API / List Clients

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.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 = @"username";
http.Password = @"password";

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"page[after]" value: @"5e1606762556d93e9c176f69"];
[queryParams UpdateString: @"page[before]" value: @"5e1606762556d93e9c176f69"];
[queryParams UpdateInt: @"page[size]" value: [NSNumber numberWithInt: 10]];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients" json: queryParams];
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;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "clients": [
//     {
//       "id": "5c9a34160c89726709136733",
//       "type": "telegram",
//       "status": "active",
//       "integrationId": "582dedf230e788746891281a",
//       "externalId": "your-own-id",
//       "lastSeen": "2020-08-20T16:13:07.462Z",
//       "linkedAt": "2020-06-23T14:33:47.492Z",
//       "displayName": "Steve",
//       "avatarUrl": "http://FyCxWeGPlJnZUcHsnFgIcfwVDdHd.dpueX8iJUlDIHClHNkd2I20OTKQLPVs8bVOVUBbGvT1n-",
//       "info": {},
//       "raw": {}
//     },
//     {
//       "id": "5c9a34160c89726709136733",
//       "type": "telegram",
//       "status": "active",
//       "integrationId": "582dedf230e788746891281a",
//       "externalId": "your-own-id",
//       "lastSeen": "2020-08-20T16:13:07.462Z",
//       "linkedAt": "2020-06-23T14:33:47.492Z",
//       "displayName": "Steve",
//       "avatarUrl": "http://TcKCiyuxrvZpuRTjBbrogTxoG.vjdxDLAN2iji7OauGJ5ui0l5aJDsCm+s5jxv+ORX6ILS-AiyUv,EWcEBviIVSpM1a05HdCgBkl22X",
//       "info": {},
//       "raw": {}
//     }
//   ],
//   "meta": {
//     "hasMore": false,
//     "afterCursor": "55c8d9758590aa1900b9b9f6",
//     "beforeCursor": "55c8d9758590aa1900b9b9f6"
//   },
//   "links": {
//     "prev": "https://api.smooch.io/v2/apps?page[before]=fcafad804c39a39648004af9",
//     "next": "https://api.smooch.io/v2/apps?page[after]=5ea868f862cdd24abf010b38"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *id = 0;
NSString *v_type = 0;
NSString *status = 0;
NSString *integrationId = 0;
NSString *externalId = 0;
NSString *lastSeen = 0;
NSString *linkedAt = 0;
NSString *displayName = 0;
NSString *avatarUrl = 0;

BOOL HasMore = [jResp BoolOf: @"meta.hasMore"];
NSString *AfterCursor = [jResp StringOf: @"meta.afterCursor"];
NSString *BeforeCursor = [jResp StringOf: @"meta.beforeCursor"];
NSString *Prev = [jResp StringOf: @"links.prev"];
NSString *v_Next = [jResp StringOf: @"links.next"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"clients"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    id = [jResp StringOf: @"clients[i].id"];
    v_type = [jResp StringOf: @"clients[i].type"];
    status = [jResp StringOf: @"clients[i].status"];
    integrationId = [jResp StringOf: @"clients[i].integrationId"];
    externalId = [jResp StringOf: @"clients[i].externalId"];
    lastSeen = [jResp StringOf: @"clients[i].lastSeen"];
    linkedAt = [jResp StringOf: @"clients[i].linkedAt"];
    displayName = [jResp StringOf: @"clients[i].displayName"];
    avatarUrl = [jResp StringOf: @"clients[i].avatarUrl"];
    i = i + 1;
}

Curl Command

curl -G -d "page[after]=5e1606762556d93e9c176f69"
	-d "page[before]=5e1606762556d93e9c176f69"
	-d "page[size]=10"
	-u 'username:password'
https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients

Postman Collection Item JSON

{
  "name": "List Clients",
  "_postman_id": "6302f027-d4a1-4272-a03c-276ea7ac4ac6",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/users/:userIdOrExternalId/clients?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "users",
        ":userIdOrExternalId",
        "clients"
      ],
      "query": [
        {
          "key": "page[after]",
          "value": "5e1606762556d93e9c176f69",
          "description": "Contains parameters for applying cursor pagination."
        },
        {
          "key": "page[before]",
          "value": "5e1606762556d93e9c176f69",
          "description": "Contains parameters for applying cursor pagination."
        },
        {
          "key": "page[size]",
          "value": "10",
          "description": "Contains parameters for applying cursor pagination."
        }
      ],
      "variable": [
        {
          "key": "userIdOrExternalId"
        }
      ]
    },
    "description": "Get all the clients for a particular user, including both linked clients and pending clients.\nThis API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits).\n\n```shell\n/v2/apps/:appId/users/:userId/clients?page[after]=5ebee0975ac5304b664a12fa\n```\n"
  },
  "response": [
    {
      "id": "2ec3b760-42a8-44d5-af25-526c4149390b",
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/users/:userIdOrExternalId/clients?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users",
            ":userIdOrExternalId",
            "clients"
          ],
          "query": [
            {
              "key": "page[after]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[before]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[size]",
              "value": "10"
            }
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "userIdOrExternalId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"clients\": [\n  {\n   \"id\": \"5c9a34160c89726709136733\",\n   \"type\": \"telegram\",\n   \"status\": \"active\",\n   \"integrationId\": \"582dedf230e788746891281a\",\n   \"externalId\": \"your-own-id\",\n   \"lastSeen\": \"2020-08-20T16:13:07.462Z\",\n   \"linkedAt\": \"2020-06-23T14:33:47.492Z\",\n   \"displayName\": \"Steve\",\n   \"avatarUrl\": \"http://FyCxWeGPlJnZUcHsnFgIcfwVDdHd.dpueX8iJUlDIHClHNkd2I20OTKQLPVs8bVOVUBbGvT1n-\",\n   \"info\": {},\n   \"raw\": {}\n  },\n  {\n   \"id\": \"5c9a34160c89726709136733\",\n   \"type\": \"telegram\",\n   \"status\": \"active\",\n   \"integrationId\": \"582dedf230e788746891281a\",\n   \"externalId\": \"your-own-id\",\n   \"lastSeen\": \"2020-08-20T16:13:07.462Z\",\n   \"linkedAt\": \"2020-06-23T14:33:47.492Z\",\n   \"displayName\": \"Steve\",\n   \"avatarUrl\": \"http://TcKCiyuxrvZpuRTjBbrogTxoG.vjdxDLAN2iji7OauGJ5ui0l5aJDsCm+s5jxv+ORX6ILS-AiyUv,EWcEBviIVSpM1a05HdCgBkl22X\",\n   \"info\": {},\n   \"raw\": {}\n  }\n ],\n \"meta\": {\n  \"hasMore\": false,\n  \"afterCursor\": \"55c8d9758590aa1900b9b9f6\",\n  \"beforeCursor\": \"55c8d9758590aa1900b9b9f6\"\n },\n \"links\": {\n  \"prev\": \"https://api.smooch.io/v2/apps?page[before]=fcafad804c39a39648004af9\",\n  \"next\": \"https://api.smooch.io/v2/apps?page[after]=5ea868f862cdd24abf010b38\"\n }\n}"
    }
  ]
}