Chilkat Online Tools

Objective-C / Sunshine Conversations API / Post Message

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.

// {
//   "author": {
//     "type": "business",
//     "displayName": "Steve",
//     "avatarUrl": "https://www.gravatar.com/image.jpg"
//   },
//   "content": {
//     "type": "text",
//     "text": "Hello!"
//   },
//   "metadata": {
//     "lang": "en-ca"
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"author.type" value: @"business"];
[json UpdateString: @"author.displayName" value: @"Steve"];
[json UpdateString: @"author.avatarUrl" value: @"https://www.gravatar.com/image.jpg"];
[json UpdateString: @"content.type" value: @"text"];
[json UpdateString: @"content.text" value: @"Hello!"];
[json UpdateString: @"metadata.lang" value: @"en-ca"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/" 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)

// {
//   "messages": [
//     {
//       "id": "5f748c1a2b5315fc007e7977",
//       "received": "2020-09-30T13:46:02.733Z",
//       "author": {
//         "type": "business",
//         "displayName": "Steve",
//         "avatarUrl": "https://www.gravatar.com/image.jpg"
//       },
//       "content": {
//         "type": "text",
//         "text": "Hello!"
//       },
//       "metadata": {
//         "lang": "en-ca"
//       },
//       "source": {
//         "type": "api:conversations"
//       }
//     }
//   ]
// }

// 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 *received = 0;
NSString *v_Type = 0;
NSString *DisplayName = 0;
NSString *AvatarUrl = 0;
NSString *contentType = 0;
NSString *Text = 0;
NSString *Lang = 0;
NSString *sourceType = 0;

int i = 0;
int count_i = [[jResp SizeOfArray: @"messages"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    id = [jResp StringOf: @"messages[i].id"];
    received = [jResp StringOf: @"messages[i].received"];
    v_Type = [jResp StringOf: @"messages[i].author.type"];
    DisplayName = [jResp StringOf: @"messages[i].author.displayName"];
    AvatarUrl = [jResp StringOf: @"messages[i].author.avatarUrl"];
    contentType = [jResp StringOf: @"messages[i].content.type"];
    Text = [jResp StringOf: @"messages[i].content.text"];
    Lang = [jResp StringOf: @"messages[i].metadata.lang"];
    sourceType = [jResp StringOf: @"messages[i].source.type"];
    i = i + 1;
}

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "author": {
        "type": "business",
        "displayName": "Steve",
        "avatarUrl": "https://www.gravatar.com/image.jpg"
    },
    "content": {
        "type": "text",
        "text": "Hello!"
    },
    "metadata": {
        "lang": "en-ca"
    }
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "Post Message",
  "_postman_id": "28e280a8-5ef8-4ca0-90fc-788603ddd036",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\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}"
    },
    "url": "{{url}}/v2/apps/{{appId}}/conversations/{{conversationId}}/messages",
    "description": "Send a message in a particular conversation."
  },
  "response": [
    {
      "id": "f660acde-ae81-4787-b433-18bf650ddef6",
      "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    \"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}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId/messages",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations",
            ":conversationId",
            "messages"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "conversationId"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"messages\": [\n  {\n   \"id\": \"5f748c1a2b5315fc007e7977\",\n   \"received\": \"2020-09-30T13:46:02.733Z\",\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   \"source\": {\n    \"type\": \"api:conversations\"\n   }\n  }\n ]\n}"
    }
  ]
}