文档帮助平台
首页服务端API参考 事件订阅 Phone事件
Phone事件
更新时间：2025-01-26 08:32:51

Phone事件

phone事件通告示例

通告参数根据事件动作，会有所不同；

目前phone事件通告的payload数据构造根据通告事件的动作种类分为以下几种：

1、通话事件

2、注册事件

3、csta控制通道事件

4、csta通话事件

1、通话事件通告

Payload参数说明

参数 类型 描述
callId string 通话中被叫对应的callId
caller callInfo caller信息
callee callInfo callee信息

callInfo对象定义

参数 类型 描述
number string 号码
registerId string 号码注册id
userId string 账号id

2、注册事件通告

Payload参数说明

参数 类型 描述
userId string 账号id
registration registration 注册信息

registration对象定义

参数 类型 描述
status string 注册状态(online,offline)
registerId string 账号注册后对应的id

3、csta控制通道事件通告

Payload参数说明

参数 类型 描述
status string 通道状态
connected:通道建立
disconnected:通道断开
registerId string 分机号注册的registerId

4、csta通话事件通告

Payload参数说明

参数 类型 描述
status string 话机事件
callStart：分机正在响铃
callAnwer：分机接听来电
callOver：分机挂断
number string 号码(企业号+分机号)
cstaCallId string 每个uaCSTA通话的Id
registerId string 分机号注册的registerId

事件描述

  • 事件名：phone.callerRing
  • 事件说明：主叫收到回铃，会触发该事件通告。

示例

{
    "event":"phone.callerRing",
    "eventTs":1625025139223,
    "payload":{
        "callId":"2_1248860572@10.50.196.37_11tCshwdSZ6CwAAAA--_1248807212",
        "caller":{
            "phoneNumber":"0564045002",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
            "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7"
        },
        "callee":{
            "phoneNumber":"0564045001"
        }
    }
}
主叫接通

事件描述

  • 事件名：phone.callerConnected
  • 事件说明：通话建立的时候，会触发该事件通告。

示例

{
    "event":"phone.callerConnected",
    "eventTs":1625025139223,
    "payload":{
        "callId":"2_1248860572@10.50.196.37_11tCshwdSZ6CwAAAA--_1248807212",
        "caller":{
            "phoneNumber":"0564045002",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
            "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7"
        },
        "callee":{
            "phoneNumber":"0564045001"
        }
    }
}
主叫通话结束

事件描述

  • 事件名：phone.callerEnded
  • 事件说明：发出的通话结束后，会触发该事件通告。

示例

{
    "event":"phone.callerEnded",
    "eventTs":1625025139223,
    "payload":{
        "callId":"2_1248860572@10.50.196.37_11tCshwdSZ6CwAAAA--_1248807212",
        "caller":{
            "phoneNumber":"0564045002",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
            "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7"
        },
        "callee":{
            "phoneNumber":"0564045001"
        },
        "handupResult":""
    }
}
被叫响铃

事件描述

  • 事件名：phone.calleeRing
  • 事件说明：被叫收到来电，会触发该事件通告。

示例

{
    "event":"phone.calleeRing",
    "eventTs":1625025139223,
    "payload":{
        "callId":"2_1460687795@10.50.196.37_C_5504_24tCshwdSZ6GAAAAA--_2256762921",
        "caller":{
            "phoneNumber":"0564045001",
            },
        "callee":{
            "phoneNumber":"0564045002",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
            "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7"
        }
    }
}
被叫拒绝

事件描述

  • 事件名：phone.calleeRejected
  • 事件说明：被叫收到来电拒绝后，会触发该事件通告。

示例

{
    "event":"phone.calleeRejected",
    "eventTs":1625025139223,
    "payload":{
        "callId":"2_1460687795@10.50.196.37_C_5504_24tCshwdSZ6GAAAAA--_2256762921",
        "caller":{
            "phoneNumber":"0564045001",
        },
        "callee":{
            "phoneNumber":"0564045002",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
            "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7",
        }
    }
}
被叫未接

事件描述

  • 事件名：phone.calleeMissed
  • 事件说明：被叫收到来电未接起后，会触发该事件通告。

示例

{
    "event":"phone.calleeMissed",
    "eventTs":1625025139223,
    "payload":{
        "callId":"2_1460687795@10.50.196.37_C_5504_24tCshwdSZ6GAAAAA--_2256762921",
        "caller":{
            "phoneNumber":"0564045001",
        },
        "callee":{
            "phoneNumber":"0564045002",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
            "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7",
        }
    }
}
被叫接起

事件描述

  • 事件名：phone.calleeAnswered
  • 事件说明：被叫接起来电后，会触发该事件通告。

示例

{
    "event":"phone.calleeAnswered",
    "eventTs":1625037414035,
    "payload":{
        "callId":"2_1460687795@10.50.196.37_C_5504_24tCshwdSZ6GAAAAA--_2256762921",
        "caller":{
            "phoneNumber":"0564045001",
        },
        "callee":{
            "phoneNumber":"0564045002",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
            "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7",
        }
    }
}
被叫挂断

事件描述

  • 事件名：phone.calleeEnded
  • 事件说明：被叫接起通话后挂断，会触发该事件通告。

示例

{
    "event":"phone.calleeEnded",
    "eventTs":1625025139223,
    "payload":{
        "callId":"2_1460687795@10.50.196.37_C_5504_24tCshwdSZ6GAAAAA--_2256762921",
        "caller":{
            "phoneNumber":"0564045001",
        },
        "callee":{
            "phoneNumber":"0564045002",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
            "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7",
        }
    }
}
注册

事件描述

  • 事件名：phone.registration
  • 事件说明：账号在设备上登录/续约/登出的时候，会触发该事件通告。

示例

{
    "event":"phone.registration",
    "eventTs":1625025139223,
    "payload":{
        "userId":"9ecc83e4c7d44728bbb1e2ec226dffe7",
        "registration":{
            "status":"online",
            "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d"
        }
    }
}
csta控制通道建立

事件描述

  • 事件名：phone.cstaCtrlChannel
  • 事件说明：终端开启csta，通道建立成功后，回触发该事件通告。

示例

{
    "event":"phone.cstaCtrlChannel",
    "eventTs":1625025139223,
    "payload":{
        "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
        "status":"connected"
    }
}
csta通话事件

事件描述

  • 事件名：phone.cstaCall
  • 事件说明：终端csta通道建立后，收到来电，会触发该事件通告。

示例

{
    "event":"phone.cstaCall",
    "eventTs":1625025139223,
    "payload":{
        "registerId":"sip:5002@056404.10.200.112.76.xip.io;gr=urn:uuid:e73263d2-b7cb-5b32-9453-776427a62e0d",
        "status":"callStart",
        "number":"0564045002",
        "cstaCallId":"32788"
    }
}
本页目录