Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_Type
LOCAL lcStatus
LOCAL lcIntegrationId
LOCAL lcExternalId
LOCAL lcLastSeen
LOCAL lcLinkedAt
LOCAL lcDisplayName
LOCAL lcAvatarUrl
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "username"
loHttp.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"
* }
* }
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("matchCriteria.type","mailgun")
loJson.UpdateString("matchCriteria.integrationId","582dedf230e788746891281a")
loJson.UpdateBool("matchCriteria.primary",1)
loJson.UpdateString("matchCriteria.address","steveb@channel5.com")
loJson.UpdateString("matchCriteria.subject","New message from {appName}")
loJson.UpdateString("confirmation.type","immediate")
loJson.UpdateString("confirmation.message.author.type","business")
loJson.UpdateString("confirmation.message.author.displayName","Steve")
loJson.UpdateString("confirmation.message.author.avatarUrl","https://www.gravatar.com/image.jpg")
loJson.UpdateString("confirmation.message.content.type","text")
loJson.UpdateString("confirmation.message.content.text","Hello!")
loJson.UpdateString("confirmation.message.metadata.lang","en-ca")
loJson.UpdateString("target.conversationId","029c31f25a21b47effd7be90")
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcId = loJResp.StringOf("client.id")
lcV_Type = loJResp.StringOf("client.type")
lcStatus = loJResp.StringOf("client.status")
lcIntegrationId = loJResp.StringOf("client.integrationId")
lcExternalId = loJResp.StringOf("client.externalId")
lcLastSeen = loJResp.StringOf("client.lastSeen")
lcLinkedAt = loJResp.StringOf("client.linkedAt")
lcDisplayName = loJResp.StringOf("client.displayName")
lcAvatarUrl = loJResp.StringOf("client.avatarUrl")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
