​

Telemarketing Capability (iOS-SDK)

• Provide the complete process of login - use - logout.
• There are 2 types of login modules: external login with token synchronization and regular username/password login.
• Supports basic functions such as call phone registration, call record inquiry, call monitoring, and agent status switching.

1. The new version of the iOS SDK supports iOS 11 and above, and is compatible with both iPhone and iPad.
2. IOS requires microphone permission; otherwise, the call function cannot work.
3. The SDK cannot be used at the same time as the call function in the Zhichi Customer Service APP and the call function in the Zhichi PC workstation.

​

Process Description

Integration Process Diagram

File Description

​

Integration Method

​

Manual Integration

​

CocoaPods Integration

// Use the latest version
pod 'SobotTMSDK'

pod repo update --verbose
If you cannot update to the latest version, delete the index file and try again.
rm ~/Library/Caches/CocoaPods/search_index.json

Delete the pod folder in the code,
pod cache clean SobotCallSDK
Run pod install again

​

Quick Start

​

Step 1 Permission Settings

<key>NSMicrophoneUsageDescription</key>
<string>Voice calls require access to your microphone permission</string>

​

Step 2 Initialization and Domain Setup

• The default SaaS platform domain name is: https://api.sobot.com.
• If you are a Tencent Cloud service, please set it to: https://www.soboten.com.
• If you are using a localized deployment, please use your own service domain name.

	SobotCallCacheEntity *config = [[SobotCallCacheEntity alloc] initWithBundleName:@"SobotCall"];
    // General interface service address
    config.openApiHost = @"https://api.sobot.com";
    // Call interface service address
    config.callApiHost = @"https://openapi.sobot.com";
    // Agent Signaling Service
    config.stompSocketUri = @"wss://openapi.sobot.com/v6.0.0/webmsg/cc-webmsg";
    // janus message listening service
    config.janusSocketUri = @"wss://rtc.sobot.com.cn/janus";
   

/// Initialize Configuration
/// @param config  SobotCallCacheEntity configuration class, domain name/internationalization/resources
/// @param kitInfo SobotKitConfig configuration class
/// @param resultBlock Initialization callback (NSInteger code, id _Nullable obj, NSString *_Nullable msg);
+(void)initWithConfig:(SobotCallCacheEntity *) config  kitInfo:(SobotTMParameter *)kitInfo result:(SobotTMResultBlock) resultBlock;

SobotCallCacheEntity *config = [[SobotCallCacheEntity alloc] initWithBundleName:@"SobotCall"];
    // Specify the bundle name
    config.bundleName = @"SobotCall"; 
    // Specify the path of the internationalization file in the bundle
    config.languageTableName = @"SobotLocalizable";     
    // Specify the internationalization file name
    config.languagePathInBundle = @"Localizable"; 
    // File name of the specified color in the bundle
    config.colorTableName = @"SobotColor";
    // Specify language
    config.absoluetelanguage = @"zh-Hans";
    
    // General interface service address
    config.openApiHost = @"https://api.sobot.com";
    // Call interface service address
    config.callApiHost = @"https://openapi.sobot.com";
    // Agent signaling service
    config.stompSocketUri = @"wss://openapi.sobot.com/v6.0.0/webmsg/cc-webmsg";
    // janus message listening service
    config.janusSocketUri = @"wss://rtc.sobot.com.cn/janus";
    
    SobotCallParameter *kitInfo = [[SobotCallParameter alloc]init];
    kitInfo.showHomeBack = NO;
    [SobotTMApi initWithConfig:config kitInfo:kitInfo result:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {

    }];

​

Step 3 Start the ZhiChi page

/// Launch SDK and enter the homepage of the Call SDK
/// @param account  Account
/// @param loginPwd Password
/// @param vc Launch VC
/// @param SobotTMResultBlock Callback result
+(void)startWithAcount:(NSString *)account password:(NSString *)loginPwd viewController:(UIViewController *)vc result:(SobotTMResultBlock) resultBlock;

/// Add launch page
/// token is not accessToken, account login returns the address, internal automatic judgment of new and old versions
+(void)startWithToken:(NSString *) token viewController:(UIViewController *) vc result:(SobotTMResultBlock) resultBlock;
    
    

[SobotTMApi startWithAcount:loginAccount password:password viewController:self result:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
}];

/// Login
/// @param account Account
/// @param loginPwd Password
/// @param SobotTMResultBlock Callback result
+(void)loginUser:(NSString *)account password:(NSString * )loginPwd result:(SobotTMResultBlock) resultBlock;

/// Login (using token)
/// @param account Account
/// @param loginPwd Password
/// @param token token
/// @param SobotTMResultBlock Callback result
+(void)loginUser:(NSString *)account password:(NSString * )loginPwd  token:(NSString *) token  result:(SobotTMResultBlock) resultBlock;

[SobotTMApi loginUser:fieldUserName.text password:fieldPassword.text token:fieldToken.text result:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
    if(code == 1){
    		// Create VC directly, decide on usage yourself
		SobotTMHomeV6Controller *tmHomeVC = [[SobotTMHomeV6Controller alloc]init];
    }
}];

//// Method Two to Launch Call Page
/// @param account  Account
/// @param app_key AppKey
/// @param appid appid
/// @param vc Launch VC
/// @param resultBlock Callback result
+(void)startWithAcount:(NSString *)account appkey:(NSString *)app_key appid:(NSString *) appid viewController:(UIViewController *)vc  result:(SobotTMResultBlock) resultBlock;
    
    

 [SobotTMApi startWithAcount:@"your account" appkey:@"your appkey" appid:@"your appid" viewController:self result:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
            
        }];

​

Function Description

​

Open API

​

Initialization

The first step in using the open API is to set the initialization configuration.

Example:

SobotCallCacheEntity *callCacheEntity = [[SobotCallCacheEntity alloc] init];
    callCacheEntity.callApiHost = @"https://openapi.soboten.com";
    callCacheEntity.openApiHost = @"https://api.sobot.com";
    callCacheEntity.stompSocketUri = @"wss://openapi.soboten.com/v6.0.0/webmsg/cc-webmsg";
    callCacheEntity.janusSocketUri = @"wss://rtc.sobot.com.cn/janus";
    [SobotTMOpenApi initWithConfig:callCacheEntity result:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
        
    }];

Request Parameters

Callback Function

​

Login Operation

Login

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added.

Example:

///  Login
/// @param account Account
/// @param loginPwd Password
/// @param token token
/// @param resultBlock Callback for login result
/// Account is required. Either password or token must have a value.
+(void)loginWithAcount:(NSString *)account
              password:(NSString * )loginPwd
                 token:(NSString *)token
                result:(SobotTMResultBlock) resultBlock;             

Request Parameters

Callback Function

​

Check In

1. The return values of this interface will keep adding attributes. Please use the correct compatible coding method to ensure that the calling code will not throw errors when return value attributes are added!
2. The system gets the latest agent ID in this interface. If you change the ID, the new ID will take effect after you sign in again.
3. Calling the check-in interface from one end will cause other ends to disconnect (not offline agents);
4. Support the login status of the agent server = offline, online, and all other status check-ins. But when the agent server’s working status = calling, ringing, in a call, on hold, or in wrap-up, check-in is not allowed.

Example:

+(void)agentLoginWithExt:(NSString *)ext
             agentStatus:(int )agentStatus
                 callWay:(int)callWay
              bindMobile:(NSString*)bindMobile
             sipPassword:(NSString *)sipPassword
                   sipIp:(NSString *)sipIp
              thisQueues:(NSArray *)thisQueues
             ResultBlock:(SobotTMResultBlock)resultBlock;           

Request Parameters

Return Value of Success Callback Function

Skill Group Information QueueAgentCheckin

Callback Function

​

Check Out

1. The return values of this interface will keep adding attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. The agent’s working status must be “Ready”, “Busy”, or “Locked”. Otherwise, it is not allowed.

Example:

  [SobotTMOpenApi logOut:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
        
    }]; 

Callback Function

​

Busy Status

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!

Example:

    [SobotTMOpenApi noReady:2 resultBlock:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
        
    }];

Request Parameters

Callback Function

​

Idle Placement

1. The return values of this interface will continue to add attributes. Please use the correct compatible coding method to ensure that the calling code will not throw errors when return value attributes are added!

Example:

    [SobotTMOpenApi ready:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
        
    }];

Callback Function

​

Query Agent’s Login Information

1. The return values of this interface will continue to add attributes. Please use the correct compatible coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. Call this interface after logging in successfully.

Example:

    +(void)queryLoginBingInfo:(SobotTMResultBlock) resultBlock;

Return Value

Callback Function

​

Query the available answering methods for the seat

1. The return values of this interface will continue to add attributes. Please use the correct compatible coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. Call this interface after logging in successfully.

Example:

    +(void)queryPhoneType:(SobotTMResultBlock) resultBlock;

Return Value

Callback Function

​

Query Available Extension Numbers for Agent Seats

1. The return values of this interface will keep adding attributes. Please use the correct compatibility method to code, ensuring that the calling-end code will not throw errors when return value attributes are added!
2. Call this interface after logging in successfully.

Example:

    +(void)queryUnusedExts:(SobotTMResultBlock)resultBlock;

Return Value

Ext Description

Callback Function

​

Query the login status of the agent

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code will not throw errors when return value attributes are added!
2. Call this interface after logging in successfully.

Example:

    +(void)queryStates:(SobotTMResultBlock)resultBlock;
    

Callback Function

​

Query Available Busy Reasons for Agent Seats

1. The return values of this interface will continue to add attributes. Please use the correct compatibility method for encoding, ensuring that the code on the calling side does not throw errors when return value attributes are added!

Example:

    +(void)queryAgentBusyStatus:(SobotTMResultBlock)resultBlock;

Return Value

AgentBusyStatus

Callback Function

​

Query the skill groups that the agent can sign in to

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!

Example:

   +(void)queryReceptionQueues:(SobotTMResultBlock)resultBlock;
   

Return Value

Callback Function

​

Reset Offline (Log Out)

1. The return values of this interface will keep adding attributes. Please use the correct compatible coding method to ensure that the calling code does not throw errors when return value attributes are added!

Example:

    +(void)logOut:(SobotTMResultBlock)resultBlock;

Callback Function

​

Call Operation

​

Outbound Call

1. The return values of this interface will continue to add attributes. Please use the correct compatibility method for coding to ensure that the calling code does not throw errors when return value attributes are added!

Example:

///  Outbound Call
/// @param otherDN Customer number
/// @param privacyNumber Customer number encryption
/// @param companyId Company ID. If not provided, the default is the companyId returned at login.
/// @param ANI  Specifies the caller ID number on the customer side
/// @param outboundPlanCode  Specifies the external number scheme code on the customer side (Optional outbound route code. According to the outbound route code set in the ZhiChi system, match an external number to call the customer)
/// @param resultBlock Result callback
+(void)makeCallWithotherDN:(NSString *)otherDN
             privacyNumber:(NSString*)privacyNumber
                 companyId:(NSString*)companyId
                       ani:(NSString *)ANI
                  userData:(NSDictionary *)userData
          outboundPlanCode:(NSString *)outboundPlanCode
               ResultBlock:(SobotTMResultBlock)resultBlock

Request Parameters

Callback Function

​

Answer the Call

1. The return values of this interface will keep adding attributes. Please use the correct compatibility coding method to ensure that the calling code won’t throw errors when new attributes are added to the return values!

Example:

    [SobotTMOpenApi answer:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
            
        }];

Callback Function

​

Hang Up

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!

Example:

    [SobotTMOpenApi hangup:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
           
        }];

Callback Function

​

Keep

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. Temporarily suspend the call between the agent and the customer. After holding, the customer will hear hold music, and the agent side will be muted.
3. This operation supports 3 answering methods: SIP phone, web page, and mobile phone.

Example:

    [SobotTMOpenApi holdCall:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
            
        }];

Callback Function

​

Cancel Hold

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. Restore the suspended call between the agent and the customer. After canceling the hold, the customer and the agent resume normal conversation.

Example:

[SobotTMOpenApi retrieveCall:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
            
        }];

Callback Function

​

Mute

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. Turn off the microphone of the operator’s station so that others cannot hear the sound from the current station. For example: Agent A consults with Agent B, and both Agent A and Agent B can operate to mute their own microphones.
3. The listener does not support this operation (the initiator’s microphone is always off during monitoring).
4. This operation supports 3 answering methods: SIP phone, web page, and mobile phone.

Example:

///   Mute
/// @param resultBlock Result callback
    [SobotTMOpenApi muteCall:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {

        }];

Callback Function

​

Unmute

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. Restore the microphone on the agent side so that others and the agent can resume normal calls.

Example:

///   Unmute
/// @param resultBlock Result callback
 [SobotTMOpenApi unmute:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
}];  
        

Callback Function

​

Query Sound Playback Type

Example:

///Query sound playback type
NSString *type = [SobotTMOpenApi searchPlayCategory];

Return Value

​

Set Sound Playback Type

Example:

///Set the type of sound playback
 [SobotTMOpenApi changedPlayCategory:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
 
}];

Return Value

Callback Function

​

Send Satisfaction

1. The return values of this interface will keep adding attributes. Please use the correct compatible coding method to ensure that the calling code will not throw errors when return value attributes are added!
2. After the agent sends the satisfaction survey, the system disconnects all agent-side calls (including monitoring; three-way calls, etc.), keeps the customer-side call, and plays the satisfaction evaluation. At the same time, it hangs up all agent-side calls.

Example:

    
/// Send Satisfaction Evaluation
/// @param resultBlock Result callback
[SobotTMOpenApi sendSatisfy:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
              }];

Callback Function

​

Extend the Tidying Duration

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. When the agent’s phone status is in wrap-up, you can extend the wrap-up duration; 30-900 seconds.

Example:

    [SobotTMOpenApi delayACW:30 ResultBlock:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {


                }];

Request Parameters

Callback Function

​

Finish Arranging

1. The return values of this interface will keep adding attributes. Please use the correct compatibility coding method to ensure that the calling code will not throw errors when return value attributes are added!
2. When the agent’s phone status is in the “organizing” state, you can end the organizing state early.

Example:

///  End of sorting
/// @param resultBlock Result callback
[SobotTMOpenApi completeACW:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
            
        }];

Callback Function

​

Finish organizing and set to busy

1. The return values of this interface will keep adding attributes. Please code with proper compatibility to ensure that the calling code won’t throw errors when new attributes are added to the return values!
2. When the agent’s phone status is in wrap-up, they can end the wrap-up status early and switch to Do Not Disturb mode.

Example:

/// End sorting and set to busy
/// @param resultBlock Result callback
[SobotTMOpenApi completeACWToBusy:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
    
}];

Return Value of Callback Function

​

Send Button

1. The return values of this interface will continue to add attributes. Please use the correct compatibility coding method to ensure that the calling code does not throw errors when return value attributes are added!

Example:

/// Send Button
/// @param dtmfDigits  Key values (Send one key value per request. For example, for 801#, send the key requests 8, 0, 1, and # in sequence. This parameter cannot be empty.)
/// @param resultBlock Result callback
[SobotTMOpenApi agentSendDtmf:@"#" ResultBlock:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
   
}];

Request Parameters

Callback Function Return Value

​

Auxiliary Operations

Query the Outbound Routing Rules for Seats

1. The return values of this interface will continue to add attributes. Please use the correct compatible coding method to ensure that the calling code does not throw errors when return value attributes are added!
2. After the agent signs in, the agent can check the outbound routing rules set in the “Outbound Routing” for agents.

Example

/// Query the outbound routing rules for agents
/// @param resultBlock Result callback.
[SobotTMOpenApi queryRoutes:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
    if(code == CALL_CODE_SUCCEEDED){
        
    }
}];   

Return Value of Callback Function

Return Value obj Description

Table 1 explicitRule Explanation of Explicit Rule Array

Table 2 explicitSchema Dynamic External Schema Array Description

Table 3 explicitNumbers Description of the explicit number array

Modify the Outbound Routing Rules for Seats

1. The return values of this interface will keep adding attributes. Please use the correct compatible coding method to ensure that the calling code won’t throw errors when new attributes are added to the return values!
2. When the agent’s phone is idle, the system can switch to the last used outbound rule for that agent.

Example:

/// Modify the outbound routing rules for the agent
/// @param explicitRule Explicit rule (1: Random match in enterprise number pool; 2: Dynamic explicit number scheme match; 3: Designated agent number pool; Single choice;)
/// @param explicitCode Dynamic explicit code  Required when the explicit rule is a dynamic explicit number plan
/// @param explicitNumber Display number. Do not use display rules. Directly specify one of the enterprise's display numbers to call the customer. At least one of the display number or display rule must be provided.
/// @param resultBlock Result callback
 [SobotTMOpenApi agentSetRouteExplicitRule:@"1" explicitCode:@"" explicitNumber:@"" resultBlock:^(NSInteger code, id  _Nullable obj, NSString * _Nullable msg) {
        
    }];      

Request Parameters

Return Value of Callback Function

Return Value

Table 1 explicitRule Array of Explicit Rules Description

Table 2 explicitSchema Dynamic External Schema Array Description

Table 3 explicitNumbers Description of the explicit number array

​

General Attribute Description

Unified Callback Interface SobotCallResultBlock

Listen for call events

//1. Use the proxy method to implement monitoring
//>1.1 Set Proxy
    [SobotTMClient getSobotTMClient].delegate = self;
    
//>1.2 Implement the proxy method
   -(void)onCallStateChanged:(SobotCallLibClientListener) state mesage:(NSString *_Nullable) message objcect:(id _Nullable )obj extends:(id _Nullable) extends;    

● SobotTMParameter Class Description

/// Change the kitConfig configuration
/// @param kitConfig  Configuration settings
+(void)configKitInfo:(SobotTMParameter *) kitConfig;


/// Initialize Configuration
/// @param config  SobotCallCacheEntity configuration class, domain name/internationalization/resources
/// @param kitInfo SobotKitConfig configuration class
/// @param resultBlock Initialization callback (NSInteger code, id _Nullable obj, NSString *_Nullable msg);
+(void)initWithConfig:(SobotCallCacheEntity *) config  kitInfo:(SobotTMParameter *)kitInfo result:(SobotTMResultBlock) resultBlock;

SobotCallCacheEntity Class Description

​

Source Code and Demo

​

Update Notes

​

Privacy and Permissions