VmsService (volc-sdk-java 1.0.109 API)

All Superinterfaces:

IBaseService

All Known Implementing Classes:

VmsServiceImpl
```
public interface VmsService
extends IBaseService
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CommonResponse<TaskAppendResult>`	`batchAppend(BatchAppendRequest request)` append phone to task
`SecretBindResponse`	`bindAXB(BindAXBRequest request)`
`SecretBindResponse`	`bindAXBForAXNE(BindAXBForAXNERequest request)`
`SecretBindResponse`	`bindAXN(BindAXNRequest request)`
`SecretBindResponse`	`bindAXNE(BindAXNERequest request)`
`SecretBindResponse`	`bindAXYB(BindAXYBRequest request)`
`SecretBindResponse`	`bindYBForAXYB(BindYBForAXYBRequest request)`
`RiskControlResponse`	`canCall(RiskControlReq request)`
`OperationResponse`	`cancelClick2Call(CancelClick2CallRequest request)`
`Click2CallResponse`	`click2Call(Click2CallRequest request)`
`CommonResponse<BasicResourceResult>`	`commitVoiceResourceUpload(UploadVoiceResourceRequest request)` commit upload request you should get a signed url and then send a http request by this signed url, finally you can invoke this function to commit your request
`CreateNumberPoolResponse`	`createNumberPool(CreateNumberPoolRequest request)` 新建号码池
`CommonResponse<TaskAppendResult>`	`createTask(CreateTaskRequest request)` create task
`CommonResponse<BasicResourceResult>`	`createTtsResource(CreateTtsResourceRequest request)` create tts resource
`CommonResponse<BasicResourceResult>`	`deleteResourceByResourceKey(String resourceKey)` delete resource by key
`EnableNumberResponse`	`enableOrDisableNumber(EnableNumberRequest request)` 批量号码启用/停用
`CommonResponse<BasicResourceResult>`	`fetchVoiceResourceByUrl(FetchVoiceResourceRequest request)` fetch voice resource from public url
`CommonResponse<BasicResourceResult>`	`generateVoiceResourceUploadUrl(UploadVoiceResourceRequest request)` get a signed url use with commitVoiceResourceUpload 1、get a signed url; 2、upload a voice resource — send a put http request to generated url; 3、invoke function of commitVoiceResourceUpload to commit request
`CommonResponse<BasicResourceResult>`	`openUpdateResource(String resourceKey, String name)` update resource name
`CommonResponse`	`pauseTask(String taskOpenId)` pause task
`QueryAudioRecordFileUrlResponse`	`queryAudioRecordFileUrl(QueryAudioRecordFileUrlRequest request)`
`QueryAudioRecordToTextFileResponse`	`queryAudioRecordToTextFile(QueryAudioRecordToTextFileRequest request)`
`QueryCallRecordMsgResponse`	`queryCallRecordMsg(QueryCallRecordRequest request)`
`NumberListResponse`	`queryNumberList(NumberListRequest request)` 查询号码列表
`NumberPoolListResponse`	`queryNumberPoolList(NumberPoolListRequest request)` 查询号码池列表
`CommonResponse<QueryOpenGetResourceResult>`	`queryOpenGetResource(QueryResourceRequest request)` query resource by form
`QuerySubscriptionResponse`	`querySubscription(SpecificSubIdRequest request)`
`QuerySubscriptionForListResponse`	`querySubscriptionForList(QuerySubscriptionForListRequest request)`
`CommonResponse<List<ResourceResult>>`	`queryUsableResource(Integer type)` query usable resource
`CommonResponse`	`resumeTask(String taskOpenId)` resume task
`SelectNumberResponse`	`selectNumber(SelectNumberRequest request)` 选号
`SecretBindResponse`	`selectNumberAndBindAXB(SelectNumberAndBindAXBRequest request)`
`SecretBindResponse`	`selectNumberAndBindAXN(SelectNumberAndBindAXNRequest request)`
`CommonResponse<SingleAppendResult>`	`singleBatchAppend(SingleAppendRequest request)` create a single call
`CommonResponse`	`singleCancel(String singleOpenId)` cancel a single call
`CommonResponse<SingleInfo>`	`singleInfo(String singleOpenId)` query a single call info
`CommonResponse`	`stopTask(String taskOpenId)` stop task
`OperationResponse`	`unbindAXB(SpecificSubIdRequest request)`
`OperationResponse`	`unbindAXN(SpecificSubIdRequest request)`
`OperationResponse`	`unbindAXNE(SpecificSubIdRequest request)`
`OperationResponse`	`unbindAXYB(SpecificSubIdRequest request)`
`OperationResponse`	`updateAXB(UpdateAXBRequest request)`
`OperationResponse`	`updateAXN(UpdateAXNRequest request)`
`OperationResponse`	`updateAXNE(UpdateAXNERequest request)`
`OperationResponse`	`updateAXYB(UpdateAXYBRequest request)`
`UpdateNumberPoolResponse`	`updateNumberPool(UpdateNumberPoolRequest request)` 更新号码池
`CommonResponse<TaskAppendResult>`	`updateTask(EditTaskRequest request)` update task info
`SecretBindResponse`	`upgradeAXToAXB(UpgradeAXToAXBRequest request)`

Methods inherited from interface com.volcengine.service.IBaseService
destroy, getAccessKey, getRegion, getSecretKey, getSessionToken, getSignUrl, json, post, proto, put, putData, query, setAccessKey, setClientNoReuse, setConnectionTimeout, setHost, setHttpClient, setRegion, setScheme, setSecretKey, setServiceInfo, setSessionToken, setSocketTimeout, signSts2

Method Detail

bindAXB

SecretBindResponse bindAXB(BindAXBRequest request)
                    throws Exception

Throws:: Exception

selectNumberAndBindAXB

SecretBindResponse selectNumberAndBindAXB(SelectNumberAndBindAXBRequest request)
                                   throws Exception

Throws:: Exception

unbindAXB

OperationResponse unbindAXB(SpecificSubIdRequest request)
                     throws Exception

Throws:: Exception

querySubscription

QuerySubscriptionResponse querySubscription(SpecificSubIdRequest request)
                                     throws Exception

Throws:: Exception

querySubscriptionForList

QuerySubscriptionForListResponse querySubscriptionForList(QuerySubscriptionForListRequest request)
                                                   throws Exception

Throws:: Exception

upgradeAXToAXB

SecretBindResponse upgradeAXToAXB(UpgradeAXToAXBRequest request)
                           throws Exception

Throws:: Exception

updateAXB

OperationResponse updateAXB(UpdateAXBRequest request)
                     throws Exception

Throws:: Exception

bindAXN

SecretBindResponse bindAXN(BindAXNRequest request)
                    throws Exception

Throws:: Exception

selectNumberAndBindAXN

SecretBindResponse selectNumberAndBindAXN(SelectNumberAndBindAXNRequest request)
                                   throws Exception

Throws:: Exception

updateAXN

OperationResponse updateAXN(UpdateAXNRequest request)
                     throws Exception

Throws:: Exception

unbindAXN

OperationResponse unbindAXN(SpecificSubIdRequest request)
                     throws Exception

Throws:: Exception

click2Call

Click2CallResponse click2Call(Click2CallRequest request)
                       throws Exception

Throws:: Exception

cancelClick2Call

OperationResponse cancelClick2Call(CancelClick2CallRequest request)
                            throws Exception

Throws:: Exception

bindAXNE

SecretBindResponse bindAXNE(BindAXNERequest request)
                     throws Exception

Throws:: Exception

unbindAXNE

OperationResponse unbindAXNE(SpecificSubIdRequest request)
                      throws Exception

Throws:: Exception

updateAXNE

OperationResponse updateAXNE(UpdateAXNERequest request)
                      throws Exception

Throws:: Exception

bindAXBForAXNE

SecretBindResponse bindAXBForAXNE(BindAXBForAXNERequest request)
                           throws Exception

Throws:: Exception

bindAXYB

SecretBindResponse bindAXYB(BindAXYBRequest request)
                     throws Exception

Throws:: Exception

bindYBForAXYB

SecretBindResponse bindYBForAXYB(BindYBForAXYBRequest request)
                          throws Exception

Throws:: Exception

unbindAXYB

OperationResponse unbindAXYB(SpecificSubIdRequest request)
                      throws Exception

Throws:: Exception

updateAXYB

OperationResponse updateAXYB(UpdateAXYBRequest request)
                      throws Exception

Throws:: Exception

queryNumberPoolList

NumberPoolListResponse queryNumberPoolList(NumberPoolListRequest request)
                                    throws Exception

查询号码池列表

Parameters:: request -
Returns:
Throws:: Exception

queryNumberList

NumberListResponse queryNumberList(NumberListRequest request)
                            throws Exception

查询号码列表

Parameters:: request -
Returns:
Throws:: Exception

createNumberPool

CreateNumberPoolResponse createNumberPool(CreateNumberPoolRequest request)
                                   throws Exception

新建号码池

Parameters:: request -
Returns:
Throws:: Exception

updateNumberPool

UpdateNumberPoolResponse updateNumberPool(UpdateNumberPoolRequest request)
                                   throws Exception

更新号码池

Parameters:: request -
Returns:
Throws:: Exception

enableOrDisableNumber

EnableNumberResponse enableOrDisableNumber(EnableNumberRequest request)
                                    throws Exception

批量号码启用/停用

Parameters:: request -
Returns:
Throws:: Exception

selectNumber

SelectNumberResponse selectNumber(SelectNumberRequest request)
                           throws Exception

选号

Parameters:: request -
Returns:
Throws:: Exception

queryCallRecordMsg

QueryCallRecordMsgResponse queryCallRecordMsg(QueryCallRecordRequest request)
                                       throws Exception

Throws:: Exception

queryAudioRecordFileUrl

QueryAudioRecordFileUrlResponse queryAudioRecordFileUrl(QueryAudioRecordFileUrlRequest request)
                                                 throws Exception

Throws:: Exception

queryAudioRecordToTextFile

QueryAudioRecordToTextFileResponse queryAudioRecordToTextFile(QueryAudioRecordToTextFileRequest request)
                                                       throws Exception

Throws:: Exception

createTask

CommonResponse<TaskAppendResult> createTask(CreateTaskRequest request)
                                     throws Exception

create task

Parameters:: request - — request
Returns:: CommonResponse
Throws:: Exception - exception

batchAppend

CommonResponse<TaskAppendResult> batchAppend(BatchAppendRequest request)
                                      throws Exception

append phone to task

Parameters:: request - — request
Returns:: CommonResponse
Throws:: Exception - exception

updateTask

CommonResponse<TaskAppendResult> updateTask(EditTaskRequest request)
                                     throws Exception

update task info

Parameters:: request - — request
Returns:: CommonResponse
Throws:: Exception - exception

pauseTask
```
CommonResponse pauseTask(String taskOpenId)
                  throws Exception
```
pause task

Parameters:

taskOpenId - — task id

Returns:

CommonResponse

Throws:

Exception - exception

resumeTask
```
CommonResponse resumeTask(String taskOpenId)
                   throws Exception
```
resume task

Parameters:

taskOpenId - — task id

Returns:

CommonResponse

Throws:

Exception - exception

stopTask
```
CommonResponse stopTask(String taskOpenId)
                 throws Exception
```
stop task

Parameters:

taskOpenId - — task id

Returns:

CommonResponse

Throws:

Exception - exception

singleBatchAppend

CommonResponse<SingleAppendResult> singleBatchAppend(SingleAppendRequest request)
                                              throws Exception

create a single call

Parameters:: request - — request
Returns:: CommonResponse
Throws:: Exception - exception

singleInfo
```
CommonResponse<SingleInfo> singleInfo(String singleOpenId)
                               throws Exception
```
query a single call info

Parameters:

singleOpenId - — singleId

Returns:

CommonResponse

Throws:

Exception - exception

singleCancel
```
CommonResponse singleCancel(String singleOpenId)
                     throws Exception
```
cancel a single call

Parameters:

singleOpenId - — singleId

Returns:

CommonResponse

Throws:

Exception - exception

fetchVoiceResourceByUrl

CommonResponse<BasicResourceResult> fetchVoiceResourceByUrl(FetchVoiceResourceRequest request)
                                                     throws Exception

fetch voice resource from public url

Parameters:: request - -- request
Returns:: CommonResponse
Throws:: Exception - exception

createTtsResource

CommonResponse<BasicResourceResult> createTtsResource(CreateTtsResourceRequest request)
                                               throws Exception

create tts resource

Parameters:: request - — request
Returns:: CommonResponse
Throws:: Exception - exception

deleteResourceByResourceKey

CommonResponse<BasicResourceResult> deleteResourceByResourceKey(String resourceKey)
                                                         throws Exception

delete resource by key

Parameters:: resourceKey - — key
Returns:: CommonResponse
Throws:: Exception - exception

generateVoiceResourceUploadUrl
```
CommonResponse<BasicResourceResult> generateVoiceResourceUploadUrl(UploadVoiceResourceRequest request)
                                                            throws Exception
```
get a signed url use with commitVoiceResourceUpload 1、get a signed url; 2、upload a voice resource — send a put http request to generated url; 3、invoke function of commitVoiceResourceUpload to commit request

Parameters:

request - — request

Returns:

CommonResponse

Throws:

Exception - exception

commitVoiceResourceUpload
```
CommonResponse<BasicResourceResult> commitVoiceResourceUpload(UploadVoiceResourceRequest request)
                                                       throws Exception
```
commit upload request you should get a signed url and then send a http request by this signed url, finally you can invoke this function to commit your request

Parameters:

request -

Returns:

Throws:

Exception

openUpdateResource

CommonResponse<BasicResourceResult> openUpdateResource(String resourceKey,
                                                       String name)
                                                throws Exception

update resource name

Parameters:: resourceKey -; name -
Returns:
Throws:: Exception

queryUsableResource

CommonResponse<List<ResourceResult>> queryUsableResource(Integer type)
                                                  throws Exception

query usable resource

Parameters:: type -
Returns:
Throws:: Exception

queryOpenGetResource

CommonResponse<QueryOpenGetResourceResult> queryOpenGetResource(QueryResourceRequest request)
                                                         throws Exception

query resource by form

Parameters:: request -
Returns:
Throws:: Exception

canCall

RiskControlResponse canCall(RiskControlReq request)
                     throws Exception

Throws:: Exception

Interface VmsService