文档首页/ 隐私保护通话 PrivateNumber/ 开发指南/ 代码样例/ Node.js代码样例/ AX模式
更新时间：2023-01-13 GMT+08:00
查看PDF
分享

AX模式

样例

AX模式绑定接口

AX模式解绑接口

AX模式绑定信息修改接口

AX模式绑定信息查询接口

AX模式设置临时被叫接口

获取录音文件下载地址接口

呼叫事件通知接口

话单通知接口

短信通知接口

环境要求

基于Node.js 8.12.0版本，要求Node.js 7.0.0及以上版本。
  • 本文档所述Demo在提供服务的过程中，可能会涉及个人数据的使用，建议您遵从国家的相关法律采取足够的措施，以确保用户的个人数据受到充分的保护。
  • 本文档所述Demo仅用于功能演示，不允许客户直接进行商业使用。
  • 本文档信息仅供参考，不构成任何要约或承诺。
  • 本文档接口携带参数只是用作参考，不可以直接复制使用，填写参数需要替换为实际值，请参考“开发准备”获取所需数据。

AX模式绑定接口

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
/*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/provision/caas/privatenumber/v1.0'; //APP接入地址+接口访问URI
var appKey = 'a1********'; //APP_Key
var appSecret = 'cfc8********'; //APP_Secret
var origNum = '+86186****5678'; //A号码
var privateNum = '+86170****0001'; //X号码(隐私号码)

/*
 * 选填,各参数要求请参考"AX模式绑定接口"
 */
var privateNumType = 'mobile-virtual'; //固定为mobile-virtual
//var areaCode = '0755'; //需要绑定的X号码对应的城市码
//var recordFlag = 'true'; //是否需要针对该绑定关系产生的所有通话录音
//var recordHintTone = 'recordHintTone.wav'; //设置录音提示音
var calleeNumDisplay = '0'; //设置非A用户呼叫X时,A接到呼叫时的主显号码
//var privateSms = 'true'; //设置该绑定关系是否支持短信功能

//var callerHintTone = 'callerHintTone.wav'; //设置A拨打X号码时的通话前等待音
//var calleeHintTone = 'calleeHintTone.wav'; //设置非A用户拨打X号码时的通话前等待音
//var preVoice = {callerHintTone, calleeHintTone};

/**
 * 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({
    'origNum':origNum,
    'privateNum':privateNum,
    'privateNumType':privateNumType,
//    'areaCode':areaCode,
//    'recordFlag':recordFlag,
//    'recordHintTone':recordHintTone,
    'calleeNumDisplay':calleeNumDisplay,
//    'privateSms':privateSms,
//    'preVoice':preVoice
});

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); //结束文件操作

AX模式解绑接口

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
/*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/provision/caas/privatenumber/v1.0'; //APP接入地址+接口访问URI
var appKey = 'a1********'; //APP_Key
var appSecret = 'cfc8********'; //APP_Secret

/*
 * 选填,各参数要求请参考"AX模式解绑接口"
 * subscriptionId和(origNum+privateNum)为二选一关系,都携带时以subscriptionId为准
 */
var origNum = '+86186****5678'; //A号码
var privateNum = '+86170****0001'; //X号码(隐私号码)
var subscriptionId = '****'; //指定"AX模式绑定接口"返回的绑定ID进行解绑

/**
 * 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({
    'origNum': origNum,
    'privateNum': privateNum,
    'subscriptionId': subscriptionId
});

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(); //结束请求

AX模式绑定信息修改接口

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
/*jshint esversion: 6 */
var https = require('https'); //引入https模块
var url = require('url'); //引入url模块

//必填,请参考"开发准备"获取如下数据,替换为实际值
var realUrl = 'https://rtcpns.cn-north-1.myhuaweicloud.com/rest/provision/caas/privatenumber/v1.0'; //APP接入地址+接口访问URI
var appKey = 'a1********'; //APP_Key
var appSecret = 'cfc8********'; //APP_Secret

/*
 * 选填,各参数要求请参考"AX模式绑定信息修改接口"
 * subscriptionId和(origNum+privateNum)为二选一关系,都携带时以subscriptionId为准
 */
var origNum = '+86186****5678'; //A号码
var privateNum = '+86170****0001'; //X号码(隐私号码)
//var subscriptionId = '****'; //指定"AX模式绑定接口"返回的绑定ID进行修改

var privateSms = 'true'; //必填,修改该绑定关系是否支持短信功能

/**
 * 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: 'PUT', //请求方法为PUT
    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({
    'origNum':origNum,
    'privateNum':privateNum,
//    'subscriptionId':subscriptionId,
    'privateSms':privateSms,
});

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.write(body); //发送请求Body数据
req.end(); //结束请求

AX模式绑定信息查询接口

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
/*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/caas/privatenumber/v1.0'; //APP接入地址+接口访问URI
var appKey = 'a1********'; //APP_Key
var appSecret = 'cfc8********'; //APP_Secret

/*
 * 选填,各参数要求请参考"AX模式绑定信息查询接口"
 * subscriptionId和origNum为二选一关系,两者都携带时以subscriptionId为准
 */
var origNum = '+86186****5678'; //指定A号码进行查询
var subscriptionId = '****'; //指定"AX模式绑定接口"返回的绑定ID进行查询

/**
 * 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({
    'origNum': origNum,
    'subscriptionId': subscriptionId
});

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); //结束文件操作

AX模式设置临时被叫接口

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
/*jshint esversion: 6 */
var https = require('https'); //引入https模块
var url = require('url'); //引入url模块

//必填,请参考"开发准备"获取如下数据,替换为实际值
var realUrl = 'https://rtcpns.cn-north-1.myhuaweicloud.com/rest/caas/privatenumber/calleenumber/v1.0'; //APP接入地址+接口访问URI
var appKey = 'a1********'; //APP_Key
var appSecret = 'cfc8********'; //APP_Secret

/*
 * 选填,各参数要求请参考"AX模式设置临时被叫接口"
 * subscriptionId和(origNum+privateNum)为二选一关系,都携带时以subscriptionId为准
 */
var origNum = '+86186****5678'; //A号码
var privateNum = '+86170****0001'; //X号码(隐私号码)
//var subscriptionId = '****'; //指定"AX模式绑定接口"返回的绑定ID进行修改

var calleeNum = '+86186****5679'; //必填,本次呼叫的真实被叫号码

/**
 * 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: 'PUT', //请求方法为PUT
    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({
    'origNum':origNum,
    'privateNum':privateNum,
//    'subscriptionId':subscriptionId,
    'calleeNum':calleeNum,
});

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.write(body); //发送请求Body数据
req.end(); //结束请求

获取录音文件下载地址接口

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
/*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); //结束文件操作

呼叫事件通知接口

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
/**
 * 呼叫事件通知
 * 客户平台收到隐私保护通话平台的呼叫事件通知的接口通知
 */

//呼叫事件通知样例
var jsonBody = JSON.stringify({
    'eventType': 'disconnect',
    'statusInfo': {
        'sessionId': '1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com',
        'timestamp': '2019-01-24 02:30:22',
        'caller': '+86138****0022',
        'called': '+86138****7021',
        'stateCode': 0,
        'stateDesc': 'The user releases the call.',
        'subscriptionId': '****'
    }
});

console.log('jsonBody:', jsonBody);

/**
 * 呼叫事件通知
 * @brief 详细内容以接口文档为准
 * @param jsonBody
 * @returns
 */
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': 被叫号码
         * 'subscriptionId': 绑定关系ID
         */
        if (statusInfo.hasOwnProperty('sessionId')) {
            console.log('sessionId:', statusInfo.sessionId);
        }
        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);

话单通知接口

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
/**
 * 话单通知
 * 客户平台收到隐私保护通话平台的话单通知的接口通知
 */

//话单通知样例
var jsonBody = JSON.stringify({
    'eventType': 'fee',
    'feeLst': [
        {
            'direction': 1,
            'spId': '****',
            'appKey': '****',
            'icid': 'ba171f34e6953fcd751edc77127748f4.3757285803.338666679.5',
            'bindNum': '+86138****0022',
            'sessionId': '1200_1827_4294967295_20190124023003@callenabler246.huaweicaas.com',
            'subscriptionId': '****',
            'callerNum': '+86138****0021',
            'calleeNum': '+86138****0022',
            'fwdDisplayNum': '+86138****0022',
            'fwdDstNum': '+86138****7021',
            'callInTime': '2019-01-24 02:30:03',
            'fwdStartTime': '2019-01-24 02:30:03',
            'fwdAlertingTime': '2019-01-24 02:30:04',
            'fwdAnswerTime': '2019-01-24 02:30:06',
            'callEndTime': '2019-01-24 02:30:22',
            'fwdUnaswRsn': 0,
            'ulFailReason': 0,
            'sipStatusCode': 0,
            'callOutUnaswRsn': 0,
            'recordFlag': 1,
            'recordStartTime': '2019-01-24 02:30:06',
            'recordDomain': '****.com',
            'recordBucketName': '****',
            'recordObjectName': '****.wav',
            'ttsPlayTimes': 0,
            'ttsTransDuration': 0,
            'mptyId': '****',
            'serviceType': '003',
            'hostName': 'callenabler246.huaweicaas.com'
        }
    ]
});

console.log('jsonBody:', jsonBody);

/**
 * 话单通知
 * @brief 详细内容以接口文档为准
 * @param jsonBody
 * @returns
 */
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
     */
    //短时间内有多个通话结束时隐私保护通话平台会将话单合并推送,每条消息最多携带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);

短信通知接口

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
/**
 * 短信通知
 * 客户平台收到隐私保护通话平台的短信通知的接口通知
 */

//短信通知样例
var jsonBody = JSON.stringify({
    'appKey': '****',
    'smsEvent': {
        'smsIdentifier': '****',
        'notificationMode': 'Block',
        'calling': '+86138****0001',
        'virtualNumber': '+86138****0000',
        'event': 'TextSMS',
        'timeStamp': '2018-09-13T09:46:16.023Z'
    }
});

console.log('jsonBody:', jsonBody);

/**
 * 短信通知
 * @brief 详细内容以接口文档为准
 * @param jsonBody
 * @returns
 */
function onSmsEvent(jsonBody) {
    var jsonObj = JSON.parse(jsonBody); //将通知消息解析为jsonObj

    if (!jsonObj.hasOwnProperty('smsEvent')) {
        console.log('param error: no smsEvent.');
        return;
    }

    //console.log('appKey:', jsonObj.appKey); //商户应用的AppKey

    var smsEvent = jsonObj.smsEvent; //短信通知信息

    /**
     * Example: 此处以解析notificationMode为例,请按需解析所需参数并自行实现相关处理
     * 
     * 'smsIdentifier': 短信唯一标识
     * 'notificationMode': 通知模式
     * 'calling': 真实发送方号码
     * 'called': 真实接收方号码
     * 'virtualNumber': 隐私号码(X号码)
     * 'event': 短信状态事件
     * 'timeStamp': 短信事件发生的系统时间戳,UTC时间
     * 'subscriptionId': 绑定ID
     * 'smsContent': 用户发送的短信内容
     */
    if (smsEvent.hasOwnProperty('notificationMode')) {
        if ('Block' === smsEvent.notificationMode) {
            //收到隐私保护通话平台的短信通知,若为Block模式,请参考接口文档回消息指示下一步操作
            var actions = {
                'operation': 'vNumberRoute', //操作类型:转发短信/丢弃短信
                'message': {
                    'called': '+86138****7022', //真实接收方号码
                    'calling': '+86138****7021' //真实发送方号码
                }
            };
            var resp = JSON.stringify({'actions': [actions]}); //Block模式响应消息
            console.log('resp:', resp);
        } else if ('Notify' === smsEvent.notificationMode) {
            //收到隐私保护通话平台的短信通知,若为Notify模式,请回HTTP状态码为200的空消息
            //var statusCode = 200;
            console.log('This is AX sms Notify mode.');
        } else {
            console.log('notificationMode param error.');
        }
    }
}

//短信通知处理
onSmsEvent(jsonBody);
父主题： Node.js代码样例

相关文档