com.volcengine.service.notify

Interface NotifyService

All Superinterfaces:

IBaseService

All Known Implementing Classes:

NotifyServiceImpl

public interface NotifyService
extends IBaseService

notify service interface

Method Summary

Modifier and Type	Method and Description
CommonResponse<TaskAppendResult>	batchAppend(BatchAppendRequest request) append phone to task
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
CommonResponse<TaskAppendResult>	createTask(CreateTaskRequest request) create task
CommonResponse<BasicResourceResult>	createTtsResource(CreateTtsResourceRequest request) create tts resource
CommonResponse<BasicResourceResult>	deleteResourceByResourceKey(String resourceKey) delete resource by key
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
CommonResponse<QueryOpenGetResourceResult>	queryOpenGetResource(QueryResourceRequest request) query resource by form
CommonResponse<List<ResourceResult>>	queryUsableResource(Integer type) query usable resource
CommonResponse	resumeTask(String taskOpenId) resume task
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
CommonResponse<TaskAppendResult>	updateTask(EditTaskRequest request) update task info

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

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