Package io.vertigo.social.plugins.sms.ovh

Interface OvhSmsWebServiceClient

All Superinterfaces:

io.vertigo.core.node.component.Amplifier, io.vertigo.core.node.component.CoreComponent

@PathPrefix("/1.0")
public interface OvhSmsWebServiceClient
extends io.vertigo.core.node.component.Amplifier

Method Summary

Modifier and Type	Method	Description
String	createSender(String serviceName, String sender, String description, String reason)
Map	getSenderDetail(String serviceName, String sender)
Map	sendSms(String serviceName, String sender, List<String> receivers, String message, boolean noStopClause)
List<String>	sms()
Map	smsService(String serviceName)
List<String>	smsServiceSenders(String serviceName)

Method Details

sendSms

@AnonymousAccessAllowed
@SessionLess
@POST("/sms/{serviceName}/jobs/")
Map sendSms(@PathParam("serviceName")
 String serviceName,
 @InnerBodyParam("sender")
 String sender,
 @InnerBodyParam("receivers")
 List<String> receivers,
 @InnerBodyParam("message")
 String message,
 @InnerBodyParam("noStopClause")
 boolean noStopClause)

sms

@AnonymousAccessAllowed
@SessionLess
@GET("/sms")
List<String> sms()

smsService

@AnonymousAccessAllowed
@SessionLess
@GET("/sms/{serviceName}")
Map smsService(@PathParam("serviceName")
 String serviceName)

smsServiceSenders

@AnonymousAccessAllowed
@SessionLess
@GET("/sms/{serviceName}/senders")
List<String> smsServiceSenders(@PathParam("serviceName")
 String serviceName)

createSender

@AnonymousAccessAllowed
@SessionLess
@POST("/sms/{serviceName}/senders")
String createSender(@PathParam("serviceName")
 String serviceName,
 @InnerBodyParam("sender")
 String sender,
 @InnerBodyParam("description")
 String description,
 @InnerBodyParam("reason")
 String reason)

getSenderDetail

@AnonymousAccessAllowed
@SessionLess
@GET("/sms/{serviceName}/senders/{sender}")
Map getSenderDetail(@PathParam("serviceName")
 String serviceName,
 @PathParam("sender")
 String sender)