# AXE模式
|    样例    | [AXE模式绑定接口] [AXE模式解绑接口] [AXE模式绑定信息查询接口] [获取录音文件下载地址接口] [呼叫事件通知接口] [话单通知接口] |
|---|---|
| **环境要求** | 基于Node.js 8.12.0版本，要求Node.js 7.0.0及以上版本。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
   
![](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模式绑定接口
```
/*jshint esversion: 6 */
var https = require('https'); // 引入https模块
var url = require('url'); // 引入url模块
var fs = require('fs'); // 引入fs模块
// 必填,请参考"开发准备"获取如下数据,替换为实际值
var realUrl = 'https://rtcpns.cn-north-1.myhuaweicloud.com/rest/caas/extendnumber/v1.0'; // APP接入地址+接口访问URI
var appKey = 'a1********'; // APP_Key
var appSecret = 'cfc8********'; // APP_Secret
var virtualNum = '+86180****0001'; // AXE中的X号码
var bindNum = '+86186****5678'; // AXE中的A号码
/*
 * 选填,各参数要求请参考"AXE模式绑定接口"
 */
//var areaCode = '0755'; // 需要绑定的X号码对应的城市码
//var displayNumMode = '0'; // 非A用户呼叫X号码时，A看到的主显号码
//var recordFlag = 'false'; // 是否需要针对该绑定关系产生的所有通话录音
//var recordHintTone = 'recordHintTone.wav'; // 设置录音提示音
//var callbackTone = 'callbackTone.wav'; // A呼叫X不存在回呼记录的提示音
//var callbackNum = '+86180****0021'; // A呼叫X不存在回呼记录的转接号码
//var bindExpiredTime = 24; // 绑定关系的有效时间
//var callbackExpiredTime = 24; // 回呼记录有效时间
//var userData = 'abcdefg'; // 用户自定义数据
/**
 * Build the X-AKSK value.
 * @param appKey
 * @param appSecret
 * @returns
 */
function buildAKSKHeader(appKey, appSecret){
    var crypto = require('crypto');
    var util = require('util');
    var time = new Date(Date.now()).toISOString().replace(/.[0-9]+\Z/, 'Z'); //Created
    var nonce = crypto.randomBytes(16).toString('hex'); //Nonce
    var passwordDigestBase64Str = crypto.createHmac('sha256', appSecret).update(nonce + time).digest('base64'); //PasswordDigest
    return util.format('UsernameToken Username="%s",PasswordDigest="%s",Nonce="%s",Created="%s"', appKey, passwordDigestBase64Str, nonce, time);
}
var urlobj = url.parse(realUrl); // 解析realUrl字符串并返回一个URL对象
var options = {
    host: urlobj.hostname, // 主机名
    port: urlobj.port, // 端口
    path: urlobj.pathname, // URI
    method: 'POST', // 请求方法为POST
    headers: { // 请求Headers
        'Content-Type': 'application/json;charset=UTF-8',
        'Authorization': 'AKSK realm="SDP",profile="UsernameToken",type="Appkey"',
        'X-AKSK': buildAKSKHeader(appKey, appSecret)
    },
    rejectUnauthorized: false // 为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题
};
var body = JSON.stringify({
    'virtualNum':virtualNum,
    'bindNum':bindNum,
// 'areaCode':areaCode,
// 'displayNumMode':displayNumMode,
// 'recordFlag':recordFlag,
// 'recordHintTone':recordHintTone,
// 'callbackTone':callbackTone,
// 'callbackNum':callbackNum,
// 'bindExpiredTime':bindExpiredTime,
// 'callbackExpiredTime':callbackExpiredTime,
// 'userData':userData
});
var req = https.request(options, (res) => {
    console.log('statusCode:', res.statusCode); // 打印响应码
    console.log('headers:', res.headers); // 打印响应Headers
    res.setEncoding('utf8'); // 设置响应数据编码格式
    res.on('data', (d) => {
        console.log('resp:', d); // 打印响应数据
        fs.appendFileSync('bind_data.txt', '绑定结果：' + d + '\n'); //绑定ID很重要,请记录到本地文件,方便后续修改绑定关系及解绑
    });
});
req.on('error', (e) => {
    console.error(e.message); // 请求错误时,打印错误信息
});
req.write(body); // 发送请求Body数据
fs.appendFileSync('bind_data.txt', '绑定请求数据：' + body + '\n'); //绑定请求参数记录到本地文件,方便定位问题
req.end(); // 结束请求
fs.closeSync(0); //结束文件操作
```
 #### AXE模式解绑接口
```
/*jshint esversion: 6 */
var https = require('https'); // 引入https模块
var url = require('url'); // 引入url模块
var querystring = require('querystring'); //引入querystring模块
// 必填,请参考"开发准备"获取如下数据,替换为实际值
var realUrl = 'https://rtcpns.cn-north-1.myhuaweicloud.com/rest/caas/extendnumber/v1.0'; // APP接入地址+接口访问URI
var appKey = 'a1********'; // APP_Key
var appSecret = 'cfc8********'; // APP_Secret
/*
 * 选填,各参数要求请参考"AXE模式解绑接口"
 * subscriptionId和(virtualNum+extendNum)二选一即可,当都传入时,优先选用subscriptionId
 */
var subscriptionId = '****'; // 指定"AXE模式绑定接口"返回的绑定ID进行解绑
var virtualNum = '+86180****0001'; // AXE中的X号码
var extendNum = '1234'; // AXE中的E号码
/**
 * Build the X-AKSK value.
 * @param appKey
 * @param appSecret
 * @returns
 */
function buildAKSKHeader(appKey, appSecret){
    var crypto = require('crypto');
    var util = require('util');
    var time = new Date(Date.now()).toISOString().replace(/.[0-9]+\Z/, 'Z'); //Created
    var nonce = crypto.randomBytes(16).toString('hex'); //Nonce
    var passwordDigestBase64Str = crypto.createHmac('sha256', appSecret).update(nonce + time).digest('base64'); //PasswordDigest
    return util.format('UsernameToken Username="%s",PasswordDigest="%s",Nonce="%s",Created="%s"', appKey, passwordDigestBase64Str, nonce, time);
}
//请求url参数
var ops = querystring.stringify({
    'subscriptionId': subscriptionId,
    'virtualNum': virtualNum,
    'extendNum': extendNum
});
var urlobj = url.parse(realUrl); // 解析realUrl字符串并返回一个URL对象
var options = {
    host: urlobj.hostname, // 主机名
    port: urlobj.port, // 端口
    path: urlobj.pathname + "?" + ops, // URI+请求url参数
    method: 'DELETE', // 请求方法为DELETE
    headers: { // 请求Headers
        'Content-Type': 'application/json;charset=UTF-8',
        'Authorization': 'AKSK realm="SDP",profile="UsernameToken",type="Appkey"',
        'X-AKSK': buildAKSKHeader(appKey, appSecret)
    },
    rejectUnauthorized: false // 为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题
};
var req = https.request(options, (res) => {
    console.log('statusCode:', res.statusCode); // 打印响应码
    console.log('headers:', res.headers); // 打印响应Headers
    res.setEncoding('utf8'); // 设置响应数据编码格式
    res.on('data', (d) => {
        console.log('resp:', d); // 打印响应数据
    });
});
req.on('error', (e) => {
    console.error(e.message); // 请求错误时,打印错误信息
});
req.end(); // 结束请求
```
 #### AXE模式绑定信息查询接口
```
/*jshint esversion: 6 */
var https = require('https'); // 引入https模块
var url = require('url'); // 引入url模块
var fs = require('fs'); // 引入fs模块
var querystring = require('querystring'); //引入querystring模块
// 必填,请参考"开发准备"获取如下数据,替换为实际值
var realUrl = 'https://rtcpns.cn-north-1.myhuaweicloud.com/rest/caas/extendnumber/v1.0'; // APP接入地址+接口访问URI
var appKey = 'a1********'; // APP_Key
var appSecret = 'cfc8********'; // APP_Secret
/*
 * 选填,各参数要求请参考"AXE模式绑定信息查询接口"
 * subscriptionId和(virtualNum+extendNum)二选一即可,当都传入时,优先选用subscriptionId
 */
var subscriptionId = '****'; // 指定"AXE模式绑定接口"返回的绑定ID进行查询
var virtualNum = '+86180****0001'; // AXE中的X号码
var extendNum = '1234'; // AXE中的E号码
/**
 * Build the X-AKSK value.
 * @param appKey
 * @param appSecret
 * @returns
 */
function buildAKSKHeader(appKey, appSecret){
    var crypto = require('crypto');
    var util = require('util');
    var time = new Date(Date.now()).toISOString().replace(/.[0-9]+\Z/, 'Z'); //Created
    var nonce = crypto.randomBytes(16).toString('hex'); //Nonce
    var passwordDigestBase64Str = crypto.createHmac('sha256', appSecret).update(nonce + time).digest('base64'); //PasswordDigest
    return util.format('UsernameToken Username="%s",PasswordDigest="%s",Nonce="%s",Created="%s"', appKey, passwordDigestBase64Str, nonce, time);
}
//请求url参数
var ops = querystring.stringify({
    'subscriptionId': subscriptionId,
    'virtualNum': virtualNum,
    'extendNum': extendNum
});
var urlobj = url.parse(realUrl); // 解析realUrl字符串并返回一个URL对象
var options = {
    host: urlobj.hostname, // 主机名
    port: urlobj.port, // 端口
    path: urlobj.pathname + "?" + ops, // URI+请求url参数
    method: 'GET', // 请求方法为GET
    headers: { // 请求Headers
        'Content-Type': 'application/json;charset=UTF-8',
        'Authorization': 'AKSK realm="SDP",profile="UsernameToken",type="Appkey"',
        'X-AKSK': buildAKSKHeader(appKey, appSecret)
    },
    rejectUnauthorized: false // 为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题
};
var req = https.request(options, (res) => {
    console.log('statusCode:', res.statusCode); // 打印响应码
    console.log('headers:', res.headers); // 打印响应Headers
    res.setEncoding('utf8'); // 设置响应数据编码格式
    res.on('data', (d) => {
        console.log('resp:', d); // 打印响应数据
        fs.appendFileSync('bind_data.txt', '绑定查询结果：' + d + '\n'); //查询结果,记录到本地文件
    });
});
req.on('error', (e) => {
    console.error(e.message); // 请求错误时,打印错误信息
});
req.end(); // 结束请求
fs.closeSync(0); //结束文件操作
```
 #### 获取录音文件下载地址接口
```
/*jshint esversion: 6 */
var https = require('https'); // 引入https模块
var url = require('url'); // 引入url模块
var fs = require('fs'); // 引入fs模块
var querystring = require('querystring'); //引入querystring模块
// 必填,请参考"开发准备"获取如下数据,替换为实际值
var realUrl = 'https://rtcpns.cn-north-1.myhuaweicloud.com/rest/provision/voice/record/v1.0'; // APP接入地址+接口访问URI
var appKey = 'a1********'; // APP_Key
var appSecret = 'cfc8********'; // APP_Secret
// 必填,通过"话单通知接口"获取
var recordDomain = '****.com'; // 录音文件存储的服务器域名
var fileName = '****.wav'; // 录音文件名
/**
 * Build the X-AKSK value.
 * @param appKey
 * @param appSecret
 * @returns
 */
function buildAKSKHeader(appKey, appSecret){
    var crypto = require('crypto');
    var util = require('util');
    var time = new Date(Date.now()).toISOString().replace(/.[0-9]+\Z/, 'Z'); //Created
    var nonce = crypto.randomBytes(16).toString('hex'); //Nonce
    var passwordDigestBase64Str = crypto.createHmac('sha256', appSecret).update(nonce + time).digest('base64'); //PasswordDigest
    return util.format('UsernameToken Username="%s",PasswordDigest="%s",Nonce="%s",Created="%s"', appKey, passwordDigestBase64Str, nonce, time);
}
//请求url参数
var ops = querystring.stringify({
    'recordDomain': recordDomain,
    'fileName': fileName
});
var urlobj = url.parse(realUrl); // 解析realUrl字符串并返回一个URL对象
var options = {
    host: urlobj.hostname, // 主机名
    port: urlobj.port, // 端口
    path: urlobj.pathname + "?" + ops, // URI+请求url参数
    method: 'GET', // 请求方法为GET
    headers: { // 请求Headers
        'Content-Type': 'application/json;charset=UTF-8',
        'Authorization': 'AKSK realm="SDP",profile="UsernameToken",type="Appkey"',
        'X-AKSK': buildAKSKHeader(appKey, appSecret)
    },
    rejectUnauthorized: false // 为防止因HTTPS证书认证失败造成API调用失败,需要先忽略证书信任问题
};
var req = https.request(options, (res) => {
    console.log('statusCode:', res.statusCode); // 打印响应码
    console.log('headers:', res.headers); // 打印响应Headers
    if(301 === res.statusCode){
        var link = Object.getOwnPropertyDescriptor(res.headers, 'location').value;
        fs.appendFileSync('bind_data.txt', '获取录音文件下载地址：' + link + '\n'); //查询结果,记录到本地文件
    }
    res.setEncoding('utf8'); // 设置响应数据编码格式
    res.on('data', (d) => {
        console.log('resp:', d); // 打印响应数据
    });
});
req.on('error', (e) => {
    console.error(e.message); // 请求错误时,打印错误信息
});
req.end(); // 结束请求
fs.closeSync(0); //结束文件操作
```
 #### 呼叫事件通知接口
```
/**
 * 呼叫事件通知
 * 客户平台收到隐私保护通话平台的呼叫事件通知的接口通知
 */
//呼叫事件通知样例
var jsonBody = JSON.stringify({
    'eventType': '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': '********'
    }
});
console.log('jsonBody:', jsonBody);
/**
 * 呼叫事件通知
 * @brief 详细内容以接口文档为准
 * @param jsonBody
 */
function onCallEvent(jsonBody) {
    var jsonObj = JSON.parse(jsonBody); //将通知消息解析为jsonObj
    var eventType = jsonObj.eventType; //通知事件类型
    if ('fee' === eventType) {
        console.log('EventType error:', eventType);
        return;
    }
    if (!jsonObj.hasOwnProperty('statusInfo')) {
        console.log('param error: no statusInfo.');
        return;
    }
    var statusInfo = jsonObj.statusInfo; //呼叫状态事件信息
    console.log('eventType:', eventType); //打印通知事件类型
    //callin：呼入事件
    if ('callin' === eventType) {
        /**
         * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理
         *
         * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳
         * 'sessionId': 通话链路的标识ID
         * 'caller': 主叫号码
         * 'called': 被叫号码
         */
        if (statusInfo.hasOwnProperty('sessionId')) {
            console.log('sessionId:', statusInfo.sessionId);
        }
        return;
    }
    //collectInfo：放音收号结果事件,仅AXE模式下的A被叫场景携带
    if ('collectInfo' === eventType) {
        /**
         * Example: 此处以解析digitInfo为例,请按需解析所需参数并自行实现相关处理
         *
         * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳
         * 'sessionId': 通话链路的标识ID
         * 'digitInfo': AXE场景中携带收号结果(即用户输入的数字)
         */
        if (statusInfo.hasOwnProperty('digitInfo')) {
            console.log('digitInfo:', statusInfo.digitInfo);
        }
        return;
    }
    //callout：呼出事件
    if ('callout' === eventType) {
        /**
         * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理
         *
         * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳
         * 'sessionId': 通话链路的标识ID
         * 'caller': 主叫号码
         * 'called': 被叫号码
         * 'subscriptionId': 绑定关系ID
         */
        if (statusInfo.hasOwnProperty('sessionId')) {
            console.log('sessionId:', statusInfo.sessionId);
        }
        return;
    }
    //alerting：振铃事件
    if ('alerting' === eventType) {
        /**
         * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理
         *
         * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳
         * 'sessionId': 通话链路的标识ID
         * 'caller': 主叫号码
         * 'called': 被叫号码
         * 'subscriptionId': 绑定关系ID
         */
        if (statusInfo.hasOwnProperty('sessionId')) {
            console.log('sessionId:', statusInfo.sessionId);
        }
        return;
    }
    //answer：应答事件
    if ('answer' === eventType) {
        /**
         * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理
         *
         * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳
         * 'sessionId': 通话链路的标识ID
         * 'caller': 主叫号码
         * 'called': 被叫号码
         * 'subscriptionId': 绑定关系ID
         */
        if (statusInfo.hasOwnProperty('sessionId')) {
            console.log('sessionId:', statusInfo.sessionId);
        }
        return;
    }
    //disconnect：挂机事件
    if ('disconnect' === eventType) {
        /**
         * Example: 此处以解析sessionId为例,请按需解析所需参数并自行实现相关处理
         *
         * 'timestamp': 呼叫事件发生时隐私保护通话平台的UNIX时间戳
         * 'sessionId': 通话链路的标识ID
         * 'caller': 主叫号码
         * 'called': 被叫号码
         * 'stateCode': 通话挂机的原因值
         * 'stateDesc': 通话挂机的原因值的描述
         * 'subscriptionId': 绑定关系ID
         */
        if (statusInfo.hasOwnProperty('sessionId')) {
            console.log('sessionId:', statusInfo.sessionId);
        }
        return;
    }
}
//呼叫事件处理
onCallEvent(jsonBody);
```
 #### 话单通知接口
```
/**
 * 话单通知
 * 客户平台收到隐私保护通话平台的话单通知的接口通知
 */
//话单通知样例
var jsonBody = JSON.stringify({
    'eventType': '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'
        }
    ]
});
console.log('jsonBody:', jsonBody);
/**
 * 话单通知
 * @brief 详细内容以接口文档为准
 * @param jsonBody
 */
function onFeeEvent(jsonBody) {
    var jsonObj = JSON.parse(jsonBody); //将通知消息解析为jsonObj
    var eventType = jsonObj.eventType; //通知事件类型
    if ('fee' !== eventType) {
        console.log('EventType error:', eventType);
        return;
    }
    if (!jsonObj.hasOwnProperty('feeLst')) {
        console.log('param error: no feeLst.');
        return;
    }
    var feeLst = jsonObj.feeLst; //呼叫话单事件信息
    /**
     * 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 (feeLst.length > 1) {
        for ( var i=0; i<feeLst.length; i++) {
            if (feeLst[i].hasOwnProperty('sessionId')) {
                console.log('sessionId:', feeLst[i].sessionId);
            }
        }
    } else if(feeLst.length === 1) {
        if (feeLst[0].hasOwnProperty('sessionId')) {
            console.log('sessionId:', feeLst[0].sessionId);
        }
    } else {
        console.log('feeLst error: no element.');
    }
}
//话单处理
onFeeEvent(jsonBody);
```