Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Id;
const wchar_t *v_Type;
const wchar_t *Status;
const wchar_t *IntegrationId;
const wchar_t *ExternalId;
const wchar_t *LastSeen;
const wchar_t *LinkedAt;
const wchar_t *DisplayName;
const wchar_t *AvatarUrl;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"username");
CkHttpW_putPassword(http,L"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"
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"matchCriteria.type",L"mailgun");
CkJsonObjectW_UpdateString(json,L"matchCriteria.integrationId",L"582dedf230e788746891281a");
CkJsonObjectW_UpdateBool(json,L"matchCriteria.primary",TRUE);
CkJsonObjectW_UpdateString(json,L"matchCriteria.address",L"steveb@channel5.com");
CkJsonObjectW_UpdateString(json,L"matchCriteria.subject",L"New message from {appName}");
CkJsonObjectW_UpdateString(json,L"confirmation.type",L"immediate");
CkJsonObjectW_UpdateString(json,L"confirmation.message.author.type",L"business");
CkJsonObjectW_UpdateString(json,L"confirmation.message.author.displayName",L"Steve");
CkJsonObjectW_UpdateString(json,L"confirmation.message.author.avatarUrl",L"https://www.gravatar.com/image.jpg");
CkJsonObjectW_UpdateString(json,L"confirmation.message.content.type",L"text");
CkJsonObjectW_UpdateString(json,L"confirmation.message.content.text",L"Hello!");
CkJsonObjectW_UpdateString(json,L"confirmation.message.metadata.lang",L"en-ca");
CkJsonObjectW_UpdateString(json,L"target.conversationId",L"029c31f25a21b47effd7be90");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
resp = CkHttpW_PostJson3(http,L"https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Id = CkJsonObjectW_stringOf(jResp,L"client.id");
v_Type = CkJsonObjectW_stringOf(jResp,L"client.type");
Status = CkJsonObjectW_stringOf(jResp,L"client.status");
IntegrationId = CkJsonObjectW_stringOf(jResp,L"client.integrationId");
ExternalId = CkJsonObjectW_stringOf(jResp,L"client.externalId");
LastSeen = CkJsonObjectW_stringOf(jResp,L"client.lastSeen");
LinkedAt = CkJsonObjectW_stringOf(jResp,L"client.linkedAt");
DisplayName = CkJsonObjectW_stringOf(jResp,L"client.displayName");
AvatarUrl = CkJsonObjectW_stringOf(jResp,L"client.avatarUrl");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
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}"
}
]
}
