# AXE模式 | 样例 | [AXE模式绑定接口] [AXE模式解绑接口] [AXE模式绑定信息查询接口] [获取录音文件下载地址接口] [呼叫事件通知接口] [话单通知接口] | |---|---| | **环境要求** | 基于PHP 7.2.9版本，要求PHP 5.6及以上版本。 | ![](https://support.huaweicloud.com/devg-PrivateNumber/public_sys-resources/notice_3.0-zh-cn.png) - 本文档所述Demo在提供服务的过程中，可能会涉及个人数据的使用，建议您遵从国家的相关法律采取足够的措施，以确保用户的个人数据受到充分的保护。 - 本文档所述Demo仅用于功能演示，不允许客户直接进行商业使用。 - 本文档信息仅供参考，不构成任何要约或承诺。 - 本文档接口携带参数只是用作参考，不可以直接复制使用，填写参数需要替换为实际值，请参考"[开发准备](https://support.huaweicloud.com/devg-PrivateNumber/privatenumber_01_0005.html)"获取所需数据。 #### AXE模式绑定接口 ``` $virtualNum, 'bindNum' => $bindNum // 'areaCode' => $areaCode, // 'displayNumMode' => $displayNumMode, // 'recordFlag' => $recordFlag, // 'recordHintTone' => $recordHintTone, // 'callbackTone' => $callbackTone, // 'callbackNum' => $callbackNum, // 'bindExpiredTime' => $bindExpiredTime, // 'callbackExpiredTime' => $callbackExpiredTime, // 'userData' => $userData ]); $context_options = [ 'http' => [ 'method' => 'POST', // 请求方法为POST 'header' => $headers, 'content' => $data, 'ignore_errors' => true // 获取错误码,方便调测 ], 'ssl' => [ 'verify_peer' => false, 'verify_peer_name' => false ] // 为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题 ]; try { $file=fopen('bind_data.txt', 'a'); //打开文件 print_r($data . PHP_EOL); // 打印请求数据 fwrite($file, '绑定请求数据：' . $data . PHP_EOL); //绑定请求参数记录到本地文件,方便定位问题 $response = file_get_contents($realUrl, false, stream_context_create($context_options)); // 发送请求 print_r($response . PHP_EOL); // 打印响应结果 fwrite($file, '绑定结果：' . $response . PHP_EOL); //绑定ID很重要,请记录到本地文件,方便后续修改绑定关系及解绑 } catch (Exception $e) { echo $e->getMessage(); } finally { fclose($file); //关闭文件 } /** * buildAKSKHeader * @param string $appKey * @param string $appSecret * @return string */ function buildAKSKHeader($appKey, $appSecret) { date_default_timezone_set("UTC"); $Created = date('Y-m-d\TH:i:s\Z'); //Created $nonce = uniqid(); //Nonce $base64 = base64_encode(hash_hmac('sha256', ($nonce . $Created), $appSecret, TRUE)); //PasswordDigest return sprintf("UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"", $appKey, $base64, $nonce, $Created); } ?> ``` #### AXE模式解绑接口 ``` $subscriptionId, 'virtualNum' => $virtualNum, 'extendNum' => $extendNum ]); // 完整请求地址 $fullUrl = $realUrl . '?' . $data; $context_options = [ 'http' => [ 'method' => 'DELETE', // 请求方法为DELETE 'header' => $headers, 'ignore_errors' => true // 获取错误码,方便调测 ], 'ssl' => [ 'verify_peer' => false, 'verify_peer_name' => false ] // 为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题 ]; try { print_r($data . PHP_EOL); // 打印请求数据 $response = file_get_contents($fullUrl, false, stream_context_create($context_options)); // 发送请求 print_r($response . PHP_EOL); // 打印响应结果 } catch (Exception $e) { echo $e->getMessage(); } /** * buildAKSKHeader * @param string $appKey * @param string $appSecret * @return string */ function buildAKSKHeader($appKey, $appSecret) { date_default_timezone_set("UTC"); $Created = date('Y-m-d\TH:i:s\Z'); //Created $nonce = uniqid(); //Nonce $base64 = base64_encode(hash_hmac('sha256', ($nonce . $Created), $appSecret, TRUE)); //PasswordDigest return sprintf("UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"", $appKey, $base64, $nonce, $Created); } ?> ``` #### AXE模式绑定信息查询接口 ``` $subscriptionId, 'virtualNum' => $virtualNum, 'extendNum' => $extendNum ]); // 完整请求地址 $fullUrl = $realUrl . '?' . $data; $context_options = [ 'http' => [ 'method' => 'GET', // 请求方法为GET 'header' => $headers, 'ignore_errors' => true // 获取错误码,方便调测 ], 'ssl' => [ 'verify_peer' => false, 'verify_peer_name' => false ] // 为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题 ]; try { $file=fopen('bind_data.txt', 'a'); //打开文件 $response = file_get_contents($fullUrl, false, stream_context_create($context_options)); // 发送请求 print_r($response . PHP_EOL); // 打印响应结果 fwrite($file, '绑定查询结果：' . $response . PHP_EOL); //查询结果,记录到本地文件 } catch (Exception $e) { echo $e->getMessage(); } finally { fclose($file); //关闭文件 } /** * buildAKSKHeader * @param string $appKey * @param string $appSecret * @return string */ function buildAKSKHeader($appKey, $appSecret) { date_default_timezone_set("UTC"); $Created = date('Y-m-d\TH:i:s\Z'); //Created $nonce = uniqid(); //Nonce $base64 = base64_encode(hash_hmac('sha256', ($nonce . $Created), $appSecret, TRUE)); //PasswordDigest return sprintf("UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"", $appKey, $base64, $nonce, $Created); } ?> ``` #### 获取录音文件下载地址接口 ``` $recordDomain, 'fileName' => $fileName ]); // 完整请求地址 $fullUrl = $realUrl . '?' . $data; $context_options = [ 'http' => [ 'method' => 'GET', // 请求方法为GET 'header' => $headers, 'max_redirects' => '0', // 关闭重定向 'ignore_errors' => true // 获取错误码,方便调测 ],// 为防止因代码工具重定向导致获取内容乱码,需要关闭重定向.若PHP是7.1.0及以上版本,若不需要可注释掉 'ssl' => [ 'verify_peer' => false, 'verify_peer_name' => false ] // 为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题 ]; //若PHP版本介于5.1.3和7.1.0之间,请使用如下代码.若PHP是7.1.0及以上版本,请注释掉如下代码 // stream_context_set_default([ // 'ssl' => [ // 'verify_peer' => false, // 'verify_peer_name' => false // ] // ]); try { $file=fopen('bind_data.txt', 'a'); //打开文件 //若PHP版本介于5.1.3和7.1.0之间,请使用如下代码获取响应消息头域信息 //$http_response_header = get_headers($fullUrl, 1); //获取响应消息头域信息 //若PHP是7.1.0及以上版本,请使用如下代码获取响应消息头域信息 $http_response_header = get_headers($fullUrl, 1, stream_context_create($context_options)); //获取响应消息头域信息 if(strpos($http_response_header[0], '301') !== false){ foreach ($http_response_header as $loop){ if(strpos($loop, "Location") !== false){ $fileUrl = trim(substr($loop, 10)); print_r($fileUrl); //获取录音文件下载地址 fwrite($file, '获取录音文件下载地址：' . $fileUrl . PHP_EOL); //查询结果,记录到本地文件 } } }else{ print_r($http_response_header[0] . PHP_EOL); //打印响应码400/401/403/500 // $response = file_get_contents($fullUrl, false, stream_context_create($context_options)); //获取响应消息数据信息 // print_r($response . PHP_EOL); // 打印响应结果 } } catch (Exception $e) { echo $e->getMessage(); } finally { fclose($file); //关闭文件 } /** * buildAKSKHeader * @param string $appKey * @param string $appSecret * @return string */ function buildAKSKHeader($appKey, $appSecret) { date_default_timezone_set("UTC"); $Created = date('Y-m-d\TH:i:s\Z'); //Created $nonce = uniqid(); //Nonce $base64 = base64_encode(hash_hmac('sha256', ($nonce . $Created), $appSecret, TRUE)); //PasswordDigest return sprintf("UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\"", $appKey, $base64, $nonce, $Created); } ?> ``` #### 呼叫事件通知接口 ``` 'disconnect', 'statusInfo' => [ 'sessionId' => '1202_1051_4294967295_20190124070250@callenabler246.huaweicaas.com', 'timestamp' => '2019-01-24 07:03:28', 'caller' => '+86138****0022', 'called' => '+86138****7021', 'stateCode' => 0, 'stateDesc' => 'The user releases the call.', 'subscriptionId' => '************' ] ]); print_r($jsonBody . PHP_EOL); //呼叫事件处理 onCallEvent($jsonBody); /** * 呼叫事件通知 * @desc 详细内容以接口文档为准 * @param jsonArr */ function onCallEvent($jsonBody) { $jsonArr = json_decode($jsonBody, true); //将通知消息解析为关联数组 $eventType = $jsonArr['eventType']; //通知事件类型 if (strcasecmp($eventType, 'fee') == 0) { print_r('EventType error: ' . $eventType); return; } if (!array_key_exists('statusInfo', $jsonArr)) { print_r('param error: no statusInfo.'); return; } $statusInfo = $jsonArr['statusInfo']; //呼叫状态事件信息 print_r('eventType: ' . $eventType . PHP_EOL); //打印通知事件类型 //callin：呼入事件 if (strcasecmp($eventType, 'callin') == 0) { /** * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理 * * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳 * 'sessionId': 通话链路的标识ID * 'caller': 主叫号码 * 'called': 被叫号码 */ if (array_key_exists('sessionId', $statusInfo)) { print_r('sessionId: ' . $statusInfo['sessionId'] . PHP_EOL); } return; ; } //collectInfo：放音收号结果事件,仅AXE模式下的A被叫场景携带 if (strcasecmp($eventType, 'collectInfo') == 0) { /** * Example: 此处以解析digitInfo为例,请按需解析所需参数并自行实现相关处理 * * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳 * 'sessionId': 通话链路的标识ID * 'digitInfo': AXE场景中携带收号结果(即用户输入的数字) */ if (array_key_exists('digitInfo', $statusInfo)) { print_r('digitInfo: ' . $statusInfo['digitInfo'] . PHP_EOL); } return; } //callout：呼出事件 if (strcasecmp($eventType, 'callout') == 0) { /** * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理 * * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳 * 'sessionId': 通话链路的标识ID * 'caller': 主叫号码 * 'called': 被叫号码 * 'subscriptionId': 绑定关系ID */ if (array_key_exists('sessionId', $statusInfo)) { print_r('sessionId: ' . $statusInfo['sessionId'] . PHP_EOL); } return; } //alerting：振铃事件 if (strcasecmp($eventType, 'alerting') == 0) { /** * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理 * * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳 * 'sessionId': 通话链路的标识ID * 'caller': 主叫号码 * 'called': 被叫号码 * 'subscriptionId': 绑定关系ID */ if (array_key_exists('sessionId', $statusInfo)) { print_r('sessionId: ' . $statusInfo['sessionId'] . PHP_EOL); } return; } //answer：应答事件 if (strcasecmp($eventType, 'answer') == 0) { /** * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理 * * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳 * 'sessionId': 通话链路的标识ID * 'caller': 主叫号码 * 'called': 被叫号码 * 'subscriptionId': 绑定关系ID */ if (array_key_exists('sessionId', $statusInfo)) { print_r('sessionId: ' . $statusInfo['sessionId'] . PHP_EOL); } return; } //disconnect：挂机事件 if (strcasecmp($eventType, 'disconnect') == 0) { /** * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理 * * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳 * 'sessionId': 通话链路的标识ID * 'caller': 主叫号码 * 'called': 被叫号码 * 'stateCode': 通话挂机的原因值 * 'stateDesc': 通话挂机的原因值的描述 * 'subscriptionId': 绑定关系ID */ if (array_key_exists('sessionId', $statusInfo)) { print_r('sessionId: ' . $statusInfo['sessionId'] . PHP_EOL); } return; } } ?> ``` #### 话单通知接口 ``` 'fee', 'feeLst' => [ [ 'direction' => 0, 'spId' => '********', 'appKey' => '************', 'icid' => 'ba171f34e6953fcd751edc77127748f4.3757289590.338833305.5', 'bindNum' => '+86138****0022', 'sessionId' => '1201_11275_4294967295_20190124033310@callenabler246.huaweicaas.com', 'subscriptionId' => '************', 'callerNum' => '+86138****7021', 'calleeNum' => '+86138****0022', 'fwdDisplayNum' => '+86138****0022', 'fwdDstNum' => '+86138****0021', 'callInTime' => '2019-01-24 03:33:10', 'fwdStartTime' => '2019-01-24 03:33:16', 'fwdAlertingTime' => '2019-01-24 03:33:19', 'fwdAnswerTime' => '2019-01-24 03:33:28', 'callEndTime' => '2019-01-24 03:33:57', 'fwdUnaswRsn' => 0, 'ulFailReason' => 0, 'sipStatusCode' => 0, 'callOutUnaswRsn' => 0, 'recordFlag' => 1, 'recordStartTime' => '2019-01-24 03:33:28', 'recordDomain' => '****.com', 'recordBucketName' => '********', 'recordObjectName' => '****.wav', 'ttsPlayTimes' => 0, 'ttsTransDuration' => 0, 'mptyId' => '********', 'serviceType' => '005', 'hostName' => 'callenabler246.huaweicaas.com', 'extendNumber' => '02' ] ] ]); print_r($jsonBody . PHP_EOL); //话单处理 onFeeEvent($jsonBody); /** * 话单通知 * @desc 详细内容以接口文档为准 * @param jsonArr */ function onFeeEvent($jsonBody) { $jsonArr = json_decode($jsonBody, true); //将通知消息解析为关联数组 $eventType = $jsonArr['eventType']; //通知事件类型 if (strcasecmp($eventType, 'fee') != 0) { print_r('EventType error: ' . $eventType); return; } if (!array_key_exists('feeLst', $jsonArr)) { print_r('param error: no feeLst.'); return; } $feeLst = $jsonArr['feeLst']; //呼叫话单事件信息 print_r('eventType: ' . $eventType . PHP_EOL); //打印通知事件类型 /** * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理 * * 'direction': 通话的呼叫方向 * 'spId': 客户的云服务账号 * 'appKey': 商户应用的AppKey * 'icid': 呼叫记录的唯一标识 * 'bindNum': 隐私保护号码 * 'sessionId': 通话链路的唯一标识 * 'callerNum': 主叫号码 * 'calleeNum': 被叫号码 * 'fwdDisplayNum': 转接呼叫时的显示号码 * 'fwdDstNum': 转接呼叫时的转接号码 * 'callInTime': 呼入的开始时间 * 'fwdStartTime': 转接呼叫操作的开始时间 * 'fwdAlertingTime': 转接呼叫操作后的振铃时间 * 'fwdAnswerTime': 转接呼叫操作后的应答时间 * 'callEndTime': 呼叫结束时间 * 'fwdUnaswRsn': 转接呼叫操作失败的Q850原因值 * 'failTime': 呼入,呼出的失败时间 * 'ulFailReason': 通话失败的拆线点 * 'sipStatusCode': 呼入,呼出的失败SIP状态码 * 'recordFlag': 录音标识 * 'recordStartTime': 录音开始时间 * 'recordObjectName': 录音文件名 * 'recordBucketName': 录音文件所在的目录名 * 'recordDomain': 存放录音文件的域名 * 'serviceType': 携带呼叫的业务类型信息 * 'hostName': 话单生成的服务器设备对应的主机名 * 'subscriptionId': 绑定关系ID * 'extendNum': 分机号E */ //短时间内有多个通话结束时隐私保护通话平台会将话单合并推送,每条消息最多携带50个话单 if (sizeof($feeLst) > 1) { foreach ($feeLst as $loop){ if (array_key_exists('sessionId', $loop)) { print_r('sessionId: ' . $loop['sessionId'] . PHP_EOL); } } } else if(sizeof($feeLst) == 1) { if (array_key_exists('sessionId', $feeLst[0])) { print_r('sessionId: ' . $feeLst[0]['sessionId'] . PHP_EOL); } } else { print_r('feeLst error: no element.'); } } ?> ```