azure-docs-sdk-java/docs-ref-autogen/com.azure.communication.sms.SmsClient.yml

### YamlMime:JavaType
uid: "com.azure.communication.sms.SmsClient"
fullName: "com.azure.communication.sms.SmsClient"
name: "SmsClient"
nameWithType: "SmsClient"
summary: "Client for sending SMS messages with Azure Communication SMS Services."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **SmsClient**"
methods:
- uid: "com.azure.communication.sms.SmsClient.send(java.lang.String,java.lang.Iterable<java.lang.String>,java.lang.String)"
  fullName: "com.azure.communication.sms.SmsClient.send(String from, Iterable<String> to, String message)"
  name: "send(String from, Iterable<String> to, String message)"
  nameWithType: "SmsClient.send(String from, Iterable<String> to, String message)"
  summary: "Sends an SMS message from a phone number that belongs to the authenticated account."
  parameters:
  - description: "Number that is sending the message."
    name: "from"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "A list of the recipient's phone numbers."
    name: "to"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
  - description: "message to send to recipient."
    name: "message"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Iterable<SmsSendResult> send(String from, Iterable<String> to, String message)"
  desc: "Sends an SMS message from a phone number that belongs to the authenticated account."
  returns:
    description: "response for a successful send Sms request."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.azure.communication.sms.models.SmsSendResult?alt=com.azure.communication.sms.models.SmsSendResult&text=SmsSendResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.sms.SmsClient.send(java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.azure.communication.sms.SmsClient.send(String from, String to, String message)"
  name: "send(String from, String to, String message)"
  nameWithType: "SmsClient.send(String from, String to, String message)"
  summary: "Sends an SMS message from a phone number that belongs to the authenticated account."
  parameters:
  - description: "Number that is sending the message."
    name: "from"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The recipient's phone number."
    name: "to"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "message to send to recipient."
    name: "message"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SmsSendResult send(String from, String to, String message)"
  desc: "Sends an SMS message from a phone number that belongs to the authenticated account."
  returns:
    description: "response for a successful send Sms request."
    type: "<xref href=\"com.azure.communication.sms.models.SmsSendResult?alt=com.azure.communication.sms.models.SmsSendResult&text=SmsSendResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.sms.SmsClient.send(java.lang.String,java.lang.String,java.lang.String,com.azure.communication.sms.models.SmsSendOptions)"
  fullName: "com.azure.communication.sms.SmsClient.send(String from, String to, String message, SmsSendOptions options)"
  name: "send(String from, String to, String message, SmsSendOptions options)"
  nameWithType: "SmsClient.send(String from, String to, String message, SmsSendOptions options)"
  summary: "Sends an SMS message from a phone number that belongs to the authenticated account."
  parameters:
  - description: "Number that is sending the message."
    name: "from"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The recipient's phone number."
    name: "to"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "message to send to recipient."
    name: "message"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "set options on the SMS request, like enable delivery report, which sends a report\n for this message to the Azure Resource Event Grid."
    name: "options"
    type: "<xref href=\"com.azure.communication.sms.models.SmsSendOptions?alt=com.azure.communication.sms.models.SmsSendOptions&text=SmsSendOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public SmsSendResult send(String from, String to, String message, SmsSendOptions options)"
  desc: "Sends an SMS message from a phone number that belongs to the authenticated account."
  returns:
    description: "The Sms send result."
    type: "<xref href=\"com.azure.communication.sms.models.SmsSendResult?alt=com.azure.communication.sms.models.SmsSendResult&text=SmsSendResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.sms.SmsClient.sendWithResponse(java.lang.String,java.lang.Iterable<java.lang.String>,java.lang.String,com.azure.communication.sms.models.SmsSendOptions,com.azure.core.util.Context)"
  fullName: "com.azure.communication.sms.SmsClient.sendWithResponse(String from, Iterable<String> to, String message, SmsSendOptions options, Context context)"
  name: "sendWithResponse(String from, Iterable<String> to, String message, SmsSendOptions options, Context context)"
  nameWithType: "SmsClient.sendWithResponse(String from, Iterable<String> to, String message, SmsSendOptions options, Context context)"
  summary: "Sends an SMS message from a phone number that belongs to the authenticated account."
  parameters:
  - description: "Number that is sending the message."
    name: "from"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "A list of the recipient's phone numbers."
    name: "to"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
  - description: "message to send to recipient."
    name: "message"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "set options on the SMS request, like enable delivery report, which sends a report\n                   for this message to the Azure Resource Event Grid."
    name: "options"
    type: "<xref href=\"com.azure.communication.sms.models.SmsSendOptions?alt=com.azure.communication.sms.models.SmsSendOptions&text=SmsSendOptions\" data-throw-if-not-resolved=\"False\" />"
  - description: "A <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref> representing the request context"
    name: "context"
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Response<Iterable<SmsSendResult>> sendWithResponse(String from, Iterable<String> to, String message, SmsSendOptions options, Context context)"
  desc: "Sends an SMS message from a phone number that belongs to the authenticated account."
  returns:
    description: "response for a successful send Sms request."
    type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.azure.communication.sms.models.SmsSendResult?alt=com.azure.communication.sms.models.SmsSendResult&text=SmsSendResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
type: "class"
desc: "Client for sending SMS messages with Azure Communication SMS Services."
metadata: {}
package: "com.azure.communication.sms"
artifact: com.azure:azure-communication-sms:1.1.29