Objective-C

CallRail API - Create an Outbound Phone Call

See more CallRail Examples

Initiates an outbound call from the target account. Objective-C

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

BOOL success = NO;

//  This example assumes the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];

//  Implements the following CURL command:

//  curl -H "Authorization: Token token={api_token}" \
//       -X POST \
//       -H "Content-Type: application/json" \
//       -d '{
//            "caller_id": "+17703334455",
//            "business_phone_number": "+14045556666",
//            "customer_phone_number": "+14044442233",
//            "recording_enabled": true,
//            "outbound_greeting_recording_url": "http://www.test.com/greeting.mp3",
//            "outbound_greeting_text": "These are not the droids you are looking for."
//           }' \
//           "https://api.callrail.com/v3/a/{account_id}/calls.json"

//  Use the following online tool to generate HTTP code from a CURL command
//  Convert a cURL Command to HTTP Source Code

//  Use this online tool to generate code from sample JSON:
//  Generate Code to Create JSON

//  The following JSON is sent in the request body.

//  {
//    "caller_id": "+17703334455",
//    "business_phone_number": "+14045556666",
//    "customer_phone_number": "+14044442233",
//    "recording_enabled": true,
//    "outbound_greeting_recording_url": "http://www.test.com/greeting.mp3",
//    "outbound_greeting_text": "These are not the droids you are looking for."
//  }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"caller_id" value: @"+17703334455"];
[json UpdateString: @"business_phone_number" value: @"+14045556666"];
[json UpdateString: @"customer_phone_number" value: @"+14044442233"];
[json UpdateBool: @"recording_enabled" value: YES];
[json UpdateString: @"outbound_greeting_recording_url" value: @"http://www.test.com/greeting.mp3"];
[json UpdateString: @"outbound_greeting_text" value: @"These are not the droids you are looking for."];

[http SetRequestHeader: @"Authorization" value: @"Token token={api_token}"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpJson: @"POST" url: @"https://api.callrail.com/v3/a/{account_id}/calls.json" json: json contentType: @"application/json" response: resp];
if (success == 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)

//  {
//    "answered": null,
//    "business_phone_number": "+19044567899",
//    "customer_city": "Atlanta",
//    "customer_country": "US",
//    "customer_name": null,
//    "customer_phone_number": "+14703444700",
//    "customer_state": "GA",
//    "direction": "outbound",
//    "duration": null,
//    "id": "CAL8154748ae6bd4e278a7cddd38a662f4f",
//    "recording": null,
//    "recording_duration": null,
//    "start_time": "2017-02-22T15:02:24.916-05:00",
//    "tracking_phone_number": "+19044567899",
//    "voicemail": false
//  }

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

NSString *answered = [jResp StringOf: @"answered"];
NSString *business_phone_number = [jResp StringOf: @"business_phone_number"];
NSString *customer_city = [jResp StringOf: @"customer_city"];
NSString *customer_country = [jResp StringOf: @"customer_country"];
NSString *customer_name = [jResp StringOf: @"customer_name"];
NSString *customer_phone_number = [jResp StringOf: @"customer_phone_number"];
NSString *customer_state = [jResp StringOf: @"customer_state"];
NSString *direction = [jResp StringOf: @"direction"];
NSString *duration = [jResp StringOf: @"duration"];
NSString *id = [jResp StringOf: @"id"];
NSString *recording = [jResp StringOf: @"recording"];
NSString *recording_duration = [jResp StringOf: @"recording_duration"];
NSString *start_time = [jResp StringOf: @"start_time"];
NSString *tracking_phone_number = [jResp StringOf: @"tracking_phone_number"];
BOOL voicemail = [jResp BoolOf: @"voicemail"];