Chat API Objective-C SDK for messengers API

The SDK allows you to receive and send messages through your messengers account. Sign up now

Download SDK and unpack the archive. Connect SDK to your project.

• API version: 1.0.0
• Package version:
• Build package: org.openapitools.codegen.languages.ObjcClientCodegen

Requirements

The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.

Installation & Usage

Install from Github using CocoaPods

Add the following to the Podfile:

pod 'OpenAPIClient', :git => 'https:////.git'

To specify a particular branch, append , :branch => 'branch-name-here'

To specify a particular commit, append , :commit => '11aa22'

Install from local path using CocoaPods

Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/OpenAPIClient) and then add the following to the Podfile:

pod 'OpenAPIClient', :path => 'Vendor/OpenAPIClient'

Usage

Import the following:

#import <OpenAPIClient/OAIApiClient.h>
#import <OpenAPIClient/OAIDefaultConfiguration.h>
// load models
#import <OpenAPIClient/OAIAck.h>
#import <OpenAPIClient/OAIBanSettings.h>
#import <OpenAPIClient/OAIBanTestAction.h>
#import <OpenAPIClient/OAIBanTestStatus.h>
#import <OpenAPIClient/OAIChat.h>
#import <OpenAPIClient/OAIchatIdProp.h>
#import <OpenAPIClient/OAIChatUpdate.h>
#import <OpenAPIClient/OAIChats.h>
#import <OpenAPIClient/OAIClearActionsQueueStatus.h>
#import <OpenAPIClient/OAIClearMessagesQueueStatus.h>
#import <OpenAPIClient/OAICreateGroupAction.h>
#import <OpenAPIClient/OAICreateGroupStatus.h>
#import <OpenAPIClient/OAIForwardMessageRequest.h>
#import <OpenAPIClient/OAIGroupParticipantAction.h>
#import <OpenAPIClient/OAIGroupParticipantStatus.h>
#import <OpenAPIClient/OAIInlineResponse200.h>
#import <OpenAPIClient/OAIInlineResponse2001.h>
#import <OpenAPIClient/OAIInlineResponse2002.h>
#import <OpenAPIClient/OAIInlineResponse2003.h>
#import <OpenAPIClient/OAIInlineResponse2004.h>
#import <OpenAPIClient/OAIInlineResponse2005.h>
#import <OpenAPIClient/OAIInlineResponse2005Update.h>
#import <OpenAPIClient/OAIInlineResponse401.h>
#import <OpenAPIClient/OAIInstanceStatus.h>
#import <OpenAPIClient/OAIInstanceStatusAction.h>
#import <OpenAPIClient/OAIInstanceStatusLink.h>
#import <OpenAPIClient/OAIInstanceStatusStatusData.h>
#import <OpenAPIClient/OAIInstanceStatusStatusDataActions.h>
#import <OpenAPIClient/OAIMessage.h>
#import <OpenAPIClient/OAIMessages.h>
#import <OpenAPIClient/OAIOutboundAction.h>
#import <OpenAPIClient/OAIOutboundActions.h>
#import <OpenAPIClient/OAIOutboundMessage.h>
#import <OpenAPIClient/OAIOutboundMessages.h>
#import <OpenAPIClient/OAIPhoneProp.h>
#import <OpenAPIClient/OAIReadChatAction.h>
#import <OpenAPIClient/OAIReadChatStatus.h>
#import <OpenAPIClient/OAISendContactRequest.h>
#import <OpenAPIClient/OAISendFileRequest.h>
#import <OpenAPIClient/OAISendLinkRequest.h>
#import <OpenAPIClient/OAISendLocationRequest.h>
#import <OpenAPIClient/OAISendMessageRequest.h>
#import <OpenAPIClient/OAISendMessageStatus.h>
#import <OpenAPIClient/OAISendPTTRequest.h>
#import <OpenAPIClient/OAISendVCardRequest.h>
#import <OpenAPIClient/OAISetWebhookStatus.h>
#import <OpenAPIClient/OAISettings.h>
#import <OpenAPIClient/OAIStatus.h>
#import <OpenAPIClient/OAIStatuses.h>
#import <OpenAPIClient/OAIWebhookStatus.h>
#import <OpenAPIClient/OAIWebhookUrl.h>
// load API classes for accessing endpoints
#import <OpenAPIClient/OAIClass1InstanceApi.h>
#import <OpenAPIClient/OAIClass2MessagesApi.h>
#import <OpenAPIClient/OAIClass3ChatsApi.h>
#import <OpenAPIClient/OAIClass4WebhooksApi.h>
#import <OpenAPIClient/OAIClass5QueuesApi.h>
#import <OpenAPIClient/OAIClass6BanApi.h>
#import <OpenAPIClient/OAIClass7TestingApi.h>

Recommendation

It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issues.

Getting Started

Please follow the installation procedure and then run the following:

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: instanceId)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"instanceId"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"instanceId"];

// Configure API key authorization: (authentication scheme: token)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];



OAIClass1InstanceApi *apiInstance = [[OAIClass1InstanceApi alloc] init];

// Updates the QR code after its expired
[apiInstance expiryWithCompletionHandler:
              ^(OAIInlineResponse2002* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

All URIs are relative to https://api.chat-api.com

Documentation For Authorization

instanceId

• Type: API key
• API key parameter name: instanceId
• Location: URL query string

token

• Type: API key
• API key parameter name: token
• Location: URL query string