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";
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "matchCriteria": {
// "type": "mailgun",
// "integrationId": "582dedf230e788746891281a",
// "primary": true,
// "address": "steveb@channel5.com",
// "subject": "New message from {appName}"
// },
// "confirmation": {
// "type": "immediate",
// "message": {
// "author": {
// "type": "business",
// "displayName": "Steve",
// "avatarUrl": "https://www.gravatar.com/image.jpg"
// },
// "content": {
// "type": "text",
// "text": "Hello!"
// },
// "metadata": {
// "lang": "en-ca"
// }
// }
// },
// "target": {
// "conversationId": "029c31f25a21b47effd7be90"
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"matchCriteria.type" value: @"mailgun"];
[json UpdateString: @"matchCriteria.integrationId" value: @"582dedf230e788746891281a"];
[json UpdateBool: @"matchCriteria.primary" value: YES];
[json UpdateString: @"matchCriteria.address" value: @"steveb@channel5.com"];
[json UpdateString: @"matchCriteria.subject" value: @"New message from {appName}"];
[json UpdateString: @"confirmation.type" value: @"immediate"];
[json UpdateString: @"confirmation.message.author.type" value: @"business"];
[json UpdateString: @"confirmation.message.author.displayName" value: @"Steve"];
[json UpdateString: @"confirmation.message.author.avatarUrl" value: @"https://www.gravatar.com/image.jpg"];
[json UpdateString: @"confirmation.message.content.type" value: @"text"];
[json UpdateString: @"confirmation.message.content.text" value: @"Hello!"];
[json UpdateString: @"confirmation.message.metadata.lang" value: @"en-ca"];
[json UpdateString: @"target.conversationId" value: @"029c31f25a21b47effd7be90"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients" contentType: @"application/json" json: json];
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)
// {
// "client": {
// "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://AKMiIDqXoOMCR.yuTZ,HeliL7IBkYuXRbpDPiRbgkrM.MhjHjbX2QqdToaIYNnnWYb8",
// "info": {},
// "raw": {}
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *Id = [jResp StringOf: @"client.id"];
NSString *v_Type = [jResp StringOf: @"client.type"];
NSString *Status = [jResp StringOf: @"client.status"];
NSString *IntegrationId = [jResp StringOf: @"client.integrationId"];
NSString *ExternalId = [jResp StringOf: @"client.externalId"];
NSString *LastSeen = [jResp StringOf: @"client.lastSeen"];
NSString *LinkedAt = [jResp StringOf: @"client.linkedAt"];
NSString *DisplayName = [jResp StringOf: @"client.displayName"];
NSString *AvatarUrl = [jResp StringOf: @"client.avatarUrl"];
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"matchCriteria": {
"type": "mailgun",
"integrationId": "582dedf230e788746891281a",
"primary": true,
"address": "steveb@channel5.com",
"subject": "New message from {appName}"
},
"confirmation": {
"type": "immediate",
"message": {
"author": {
"type": "business",
"displayName": "Steve",
"avatarUrl": "https://www.gravatar.com/image.jpg"
},
"content": {
"type": "text",
"text": "Hello!"
},
"metadata": {
"lang": "en-ca"
}
}
},
"target": {
"conversationId": "029c31f25a21b47effd7be90"
}
}'
https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients
Postman Collection Item JSON
{
"name": "Create Client",
"_postman_id": "e51d89dc-e2b1-4839-9eed-67dc8387cdaf",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"matchCriteria\": {\n \"type\": \"mailgun\",\n \"integrationId\": \"582dedf230e788746891281a\",\n \"primary\": true,\n \"address\": \"steveb@channel5.com\",\n \"subject\": \"New message from {appName}\"\n },\n \"confirmation\": {\n \"type\": \"immediate\",\n \"message\": {\n \"author\": {\n \"type\": \"business\",\n \"displayName\": \"Steve\",\n \"avatarUrl\": \"https://www.gravatar.com/image.jpg\"\n },\n \"content\": {\n \"type\": \"text\",\n \"text\": \"Hello!\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n }\n },\n \"target\": {\n \"conversationId\": \"029c31f25a21b47effd7be90\"\n }\n}"
},
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/users/:userIdOrExternalId/clients",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"users",
":userIdOrExternalId",
"clients"
],
"variable": [
{
"key": "userIdOrExternalId"
}
]
},
"description": "Create a client and link it to a channel specified by the matchCriteria.type."
},
"response": [
{
"id": "74e580bd-67c5-486e-a95e-0e37794255b3",
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"matchCriteria\": {\n \"type\": \"mailgun\",\n \"integrationId\": \"582dedf230e788746891281a\",\n \"primary\": true,\n \"address\": \"steveb@channel5.com\",\n \"subject\": \"New message from {appName}\"\n },\n \"confirmation\": {\n \"type\": \"immediate\",\n \"message\": {\n \"author\": {\n \"type\": \"business\",\n \"displayName\": \"Steve\",\n \"avatarUrl\": \"https://www.gravatar.com/image.jpg\"\n },\n \"content\": {\n \"type\": \"text\",\n \"text\": \"Hello!\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n }\n },\n \"target\": {\n \"conversationId\": \"029c31f25a21b47effd7be90\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/users/:userIdOrExternalId/clients",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"users",
":userIdOrExternalId",
"clients"
],
"variable": [
{
"key": "appId"
},
{
"key": "userIdOrExternalId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"client\": {\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://AKMiIDqXoOMCR.yuTZ,HeliL7IBkYuXRbpDPiRbgkrM.MhjHjbX2QqdToaIYNnnWYb8\",\n \"info\": {},\n \"raw\": {}\n }\n}"
}
]
}
