本頁面由 Cloud Translation API 翻譯而成。

建構應用程式伺服器傳送要求

您可以使用 Firebase Admin SDK 或 FCM 應用程式伺服器通訊協定，建立訊息要求並傳送至下列類型的目標：

主題名稱
條件
裝置註冊權杖
裝置群組名稱 (僅限通訊協定)

傳送的訊息可具有由預先定義欄位組成的通知酬載、由您自己定義欄位的資料酬載，或是包含這兩種酬載的訊息。詳情請參閱訊息類型。

本頁中的範例說明如何使用 Firebase Admin SDK (支援 Node、Java、Python、C# 和 Go) 和 v1 HTTP 通訊協定傳送通知訊息。我們也提供指引，說明如何透過已淘汰的舊版 HTTP 和 XMPP 通訊協定傳送訊息。

傳送訊息至特定裝置

如要傳送至單一特定裝置，請如圖所示傳遞裝置的註冊權杖。請參閱平台的用戶端設定資訊，進一步瞭解註冊權杖。

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'YOUR_REGISTRATION_TOKEN';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  token: registrationToken
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Java

// This registration token comes from the client FCM SDKs.
String registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setToken(registrationToken)
    .build();

// Send a message to the device corresponding to the provided
// registration token.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);FirebaseMessagingSnippets.java

Python

# This registration token comes from the client FCM SDKs.
registration_token = 'YOUR_REGISTRATION_TOKEN'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    token=registration_token,
)

# Send a message to the device corresponding to the provided
# registration token.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)cloud_messaging.py

Go

// Obtain a messaging.Client from the App.
ctx := context.Background()
client, err := app.Messaging(ctx)
if err != nil {
	log.Fatalf("error getting Messaging client: %v\n", err)
}

// This registration token comes from the client FCM SDKs.
registrationToken := "YOUR_REGISTRATION_TOKEN"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Token: registrationToken,
}

// Send a message to the device corresponding to the provided
// registration token.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)messaging.go

C#

// This registration token comes from the client FCM SDKs.
var registrationToken = "YOUR_REGISTRATION_TOKEN";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Token = registrationToken,
};

// Send a message to the device corresponding to the provided
// registration token.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...",
      "notification":{
        "body":"This is an FCM notification message!",
        "title":"FCM Message"
      }
   }
}

cURL 指令：

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "notification":{
     "title":"FCM Message",
     "body":"This is an FCM Message"
   },
   "token":"bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

傳送成功後，每個傳送方法都會傳回訊息 ID。Firebase Admin SDK 會以 projects/{project_id}/messages/{message_id} 格式傳回 ID 字串。HTTP 通訊協定回應是單一 JSON 金鑰：

    {
      "name":"projects/myproject-b5ae1/messages/0:1500415314455276%31bd1c9631bd1c96"
    }

將訊息傳送至多部裝置

您可以使用管理員 FCM API 將訊息多播至裝置註冊權杖清單。每次叫用最多可指定 500 個裝置註冊權杖。

Node.js

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

Java

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");FirebaseMessagingSnippets.java

Python

# Create a list containing up to 500 registration tokens.
# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))cloud_messaging.py

Go

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)messaging.go

C#

// Create a list containing up to 500 registration tokens.
// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");FirebaseMessagingSnippets.cs

傳回值是符記清單，對應於輸入符記的順序。這很適合用來查看哪些權杖導致錯誤。

Node.js

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'YOUR_REGISTRATION_TOKEN_1',
  // …
  'YOUR_REGISTRATION_TOKEN_N',
];

const message = {
  data: {score: '850', time: '2:45'},
  tokens: registrationTokens,
};

getMessaging().sendMulticast(message)
  .then((response) => {
    if (response.failureCount > 0) {
      const failedTokens = [];
      response.responses.forEach((resp, idx) => {
        if (!resp.success) {
          failedTokens.push(registrationTokens[idx]);
        }
      });
      console.log('List of tokens that caused failures: ' + failedTokens);
    }
  });

Java

// These registration tokens come from the client FCM SDKs.
List<String> registrationTokens = Arrays.asList(
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n"
);

MulticastMessage message = MulticastMessage.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .addAllTokens(registrationTokens)
    .build();
BatchResponse response = FirebaseMessaging.getInstance().sendMulticast(message);
if (response.getFailureCount() > 0) {
  List<SendResponse> responses = response.getResponses();
  List<String> failedTokens = new ArrayList<>();
  for (int i = 0; i < responses.size(); i++) {
    if (!responses.get(i).isSuccessful()) {
      // The order of responses corresponds to the order of the registration tokens.
      failedTokens.add(registrationTokens.get(i));
    }
  }

  System.out.println("List of tokens that caused failures: " + failedTokens);
}FirebaseMessagingSnippets.java

Python

# These registration tokens come from the client FCM SDKs.
registration_tokens = [
    'YOUR_REGISTRATION_TOKEN_1',
    # ...
    'YOUR_REGISTRATION_TOKEN_N',
]

message = messaging.MulticastMessage(
    data={'score': '850', 'time': '2:45'},
    tokens=registration_tokens,
)
response = messaging.send_multicast(message)
if response.failure_count > 0:
    responses = response.responses
    failed_tokens = []
    for idx, resp in enumerate(responses):
        if not resp.success:
            # The order of responses corresponds to the order of the registration tokens.
            failed_tokens.append(registration_tokens[idx])
    print('List of tokens that caused failures: {0}'.format(failed_tokens))cloud_messaging.py

Go

// Create a list containing up to 500 registration tokens.
// This registration tokens come from the client FCM SDKs.
registrationTokens := []string{
	"YOUR_REGISTRATION_TOKEN_1",
	// ...
	"YOUR_REGISTRATION_TOKEN_n",
}
message := &messaging.MulticastMessage{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Tokens: registrationTokens,
}

br, err := client.SendMulticast(context.Background(), message)
if err != nil {
	log.Fatalln(err)
}

if br.FailureCount > 0 {
	var failedTokens []string
	for idx, resp := range br.Responses {
		if !resp.Success {
			// The order of responses corresponds to the order of the registration tokens.
			failedTokens = append(failedTokens, registrationTokens[idx])
		}
	}

	fmt.Printf("List of tokens that caused failures: %v\n", failedTokens)
}messaging.go

C#

// These registration tokens come from the client FCM SDKs.
var registrationTokens = new List<string>()
{
    "YOUR_REGISTRATION_TOKEN_1",
    // ...
    "YOUR_REGISTRATION_TOKEN_n",
};
var message = new MulticastMessage()
{
    Tokens = registrationTokens,
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachForMulticastAsync(message);
if (response.FailureCount > 0)
{
    var failedTokens = new List<string>();
    for (var i = 0; i < response.Responses.Count; i++)
    {
        if (!response.Responses[i].IsSuccess)
        {
            // The order of responses corresponds to the order of the registration tokens.
            failedTokens.Add(registrationTokens[i]);
        }
    }

    Console.WriteLine($"List of tokens that caused failures: {failedTokens}");
}
FirebaseMessagingSnippets.cs

傳送訊息至主題

建立主題後，您可以透過訂閱用戶端應用程式執行個體，或透過伺服器 API，將訊息傳送至主題。如果這是您第一次為 FCM 建構要求，請參閱伺服器環境和 FCM 指南，瞭解重要背景和設定資訊。

在後端的傳送邏輯中，指定所需的專案名稱，如下所示：

Node.js

// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';

const message = {
  data: {
    score: '850',
    time: '2:45'
  },
  topic: topic
};

// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Java

// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";

// See documentation on defining a message payload.
Message message = Message.builder()
    .putData("score", "850")
    .putData("time", "2:45")
    .setTopic(topic)
    .build();

// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);FirebaseMessagingSnippets.java

Python

# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'

# See documentation on defining a message payload.
message = messaging.Message(
    data={
        'score': '850',
        'time': '2:45',
    },
    topic=topic,
)

# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)cloud_messaging.py

Go

// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Topic: topic,
}

// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)messaging.go

C#

// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";

// See documentation on defining a message payload.
var message = new Message()
{
    Data = new Dictionary<string, string>()
    {
        { "score", "850" },
        { "time", "2:45" },
    },
    Topic = topic,
};

// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
    "topic" : "foo-bar",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message"
      }
   }
}

cURL 指令：

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "message": {
    "topic" : "foo-bar",
    "notification": {
      "body": "This is a Firebase Cloud Messaging Topic Message!",
      "title": "FCM Message"
    }
  }
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

如要傳送訊息至主題的「組合」，請指定「條件」，這是指定了目標主題的布林值運算式。舉例來說，下列條件會將訊息傳送至已訂閱 TopicA 和 TopicB 或 TopicC 的裝置：

"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"

FCM 會先評估括號中的任何條件，然後從左到右評估運算式。在上述運算式中，訂閱任何單一主題的使用者都不會收到訊息。同樣地，未訂閱 TopicA 的使用者也不會收到訊息。以下組合會收到這項通知：

TopicA 和 TopicB
TopicA 和 TopicC

您最多可以在條件式運算式中加入五個主題。

如要傳送至條件：

Node.js

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';

// See documentation on defining a message payload.
const message = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  condition: condition
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Java

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setCondition(condition)
    .build();

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);FirebaseMessagingSnippets.java

Python

# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"

# See documentation on defining a message payload.
message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    condition=condition,
)

# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)cloud_messaging.py

Go

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"

// See documentation on defining a message payload.
message := &messaging.Message{
	Data: map[string]string{
		"score": "850",
		"time":  "2:45",
	},
	Condition: condition,
}

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
	log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)messaging.go

C#

// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";

// See documentation on defining a message payload.
var message = new Message()
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Condition = condition,
};

// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
   "message":{
    "condition": "'dogs' in topics || 'cats' in topics",
    "notification" : {
      "body" : "This is a Firebase Cloud Messaging Topic Message!",
      "title" : "FCM Message",
    }
  }
}

cURL 指令：

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
  "notification": {
    "title": "FCM Message",
    "body": "This is a Firebase Cloud Messaging Topic Message!",
  },
  "condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

傳送訊息至裝置群組

如要傳送訊息給裝置群組，請使用 HTTP v1 API。如果您目前使用已淘汰的舊版 HTTP 或 XMPP 傳送 API，或任何舊版 Firebase Admin SDK for Node.js，以舊版通訊協定傳送至裝置群組，強烈建議您盡快遷移至 HTTP v1 API。舊版傳送 API 將於 2024 年 6 月停用及移除。

傳送訊息給裝置群組與傳送訊息給個別裝置非常相似，兩者都使用相同的方法授權傳送要求。將 token 欄位設為群組通知索引鍵：

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
   "message":{
      "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ",
      "data":{
        "hello": "This is a Firebase Cloud Messaging device group message!"
      }
   }
}

cURL 指令

curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message":{
   "data":{
     "hello": "This is a Firebase Cloud Messaging device group message!"
   },
   "token":"APA91bGHXQBB...9QgnYOEURwm0I3lmyqzk2TXQ"
}}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

大量傳送訊息

管理員 SDK 支援以批次傳送訊息。您可以將最多 500 則訊息分組成單一批次，然後透過單一 API 呼叫傳送，這樣比針對每則訊息傳送個別 HTTP 要求，可大幅提升效能。

這項功能可用於建立自訂訊息組合，並將這些訊息傳送給不同的收件者，包括主題或特定裝置註冊權杖。例如，如果您需要同時傳送訊息給不同目標對象，且訊息內文的詳細資料略有不同，就請使用這項功能。

Node.js

// Create a list containing up to 500 messages.
const messages = [];
messages.push({
  notification: { title: 'Price drop', body: '5% off all electronics' },
  token: registrationToken,
});
messages.push({
  notification: { title: 'Price drop', body: '2% off all books' },
  topic: 'readers-club',
});

getMessaging().sendAll(messages)
  .then((response) => {
    console.log(response.successCount + ' messages were sent successfully');
  });

Java

// Create a list containing up to 500 messages.
List<Message> messages = Arrays.asList(
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("5% off all electronics")
            .build())
        .setToken(registrationToken)
        .build(),
    // ...
    Message.builder()
        .setNotification(Notification.builder()
            .setTitle("Price drop")
            .setBody("2% off all books")
            .build())
        .setTopic("readers-club")
        .build()
);

BatchResponse response = FirebaseMessaging.getInstance().sendAll(messages);
// See the BatchResponse reference documentation
// for the contents of response.
System.out.println(response.getSuccessCount() + " messages were sent successfully");FirebaseMessagingSnippets.java

Python

# Create a list containing up to 500 messages.
messages = [
    messaging.Message(
        notification=messaging.Notification('Price drop', '5% off all electronics'),
        token=registration_token,
    ),
    # ...
    messaging.Message(
        notification=messaging.Notification('Price drop', '2% off all books'),
        topic='readers-club',
    ),
]

response = messaging.send_all(messages)
# See the BatchResponse reference documentation
# for the contents of response.
print('{0} messages were sent successfully'.format(response.success_count))cloud_messaging.py

Go

// Create a list containing up to 500 messages.
messages := []*messaging.Message{
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "5% off all electronics",
		},
		Token: registrationToken,
	},
	{
		Notification: &messaging.Notification{
			Title: "Price drop",
			Body:  "2% off all books",
		},
		Topic: "readers-club",
	},
}

br, err := client.SendAll(context.Background(), messages)
if err != nil {
	log.Fatalln(err)
}

// See the BatchResponse reference documentation
// for the contents of response.
fmt.Printf("%d messages were sent successfully\n", br.SuccessCount)messaging.go

C#

// Create a list containing up to 500 messages.
var messages = new List<Message>()
{
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "5% off all electronics",
        },
        Token = registrationToken,
    },
    new Message()
    {
        Notification = new Notification()
        {
            Title = "Price drop",
            Body = "2% off all books",
        },
        Topic = "readers-club",
    },
};

var response = await FirebaseMessaging.DefaultInstance.SendEachAsync(messages);
// See the BatchResponse reference documentation
// for the contents of response.
Console.WriteLine($"{response.SuccessCount} messages were sent successfully");FirebaseMessagingSnippets.cs

傳送啟用直接啟動的訊息 (僅限 Android)

您可以使用 HTTP v1 或舊版 HTTP API，將訊息傳送至直接啟動模式的裝置。在傳送至直接啟動模式的裝置前，請先完成相關步驟，讓用戶端裝置在直接啟動模式下接收 FCM 訊息。

使用 FCM v1 HTTP API 傳送

訊息要求必須在要求主體的 AndroidConfig 選項中加入 "direct_boot_ok" : true 鍵。例如：

https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send
Content-Type:application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

{
  "message":{
    "token" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
    "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "android": {
      "direct_boot_ok": true,
    },
}

使用 FCM 舊版 HTTP API 傳送

訊息要求必須在要求主體的頂層包含 "direct_boot_ok" : true 鍵。例如：

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  "direct_boot_ok" : true
}

如果裝置目前處於直接啟動模式 (或是在該模式下未處於該模式)，可在要求主體中透過這組金鑰傳送的訊息進行處理。

跨平台自訂訊息

Firebase Admin SDK 和 FCM v1 HTTP 通訊協定都允許訊息要求設定 message 物件中可用的所有欄位。包括：

一組常見的欄位，可供所有接收訊息的應用程式執行個體解讀。
平台專屬欄位組合 (例如 AndroidConfig 和 WebpushConfig)，只能由在指定平台上執行的應用程式執行個體解讀。

您可以使用特定平台的區塊，靈活地為不同平台自訂訊息，確保訊息在收到時能正確處理。FCM 後端會考量所有指定參數，並為各平台自訂訊息。

使用常用欄位的時機

使用常用欄位時，請注意：

指定所有平台 (Apple、Android 和網站) 上的應用程式執行個體
傳送訊息至主題

所有應用程式執行個體 (無論平台為何) 都可以解讀下列常用欄位：

使用特定平台欄位的時機

請在下列情況下使用平台專屬欄位：

只將欄位傳送至特定平台
除了常用欄位以外，也傳送平台專屬欄位

如要只將值傳送至特定平台，請不要使用通用欄位，而應使用特定平台的欄位。舉例來說，如果您想只將通知傳送給 Apple 平台和網頁，但不傳送給 Android，就必須使用兩組不同的欄位，一組用於 Apple，另一組用於網頁。

傳送含有特定傳送選項的郵件時，請使用特定平台的欄位進行設定。您可以視需要為每個平台指定不同的值。不過，即使您想在各平台上設定相同的值，也必須使用平台專屬的欄位。這是因為每個平台對值解譯的方式可能略有不同。舉例來說，在 Android 上，存留時間會設為以秒為單位的到期時間，在 Apple 上則則設為到期「日期」。

範例：含有顏色和圖示選項的通知訊息

這個範例傳送要求會將常見的通知標題和內容傳送至所有平台，但也會將某些平台專屬的覆寫值傳送至 Android 裝置。

如果是 Android，要求會設定 Android 裝置顯示的特殊圖示和顏色。如 AndroidNotification 的參考資料所述，顏色是以 #rrggbb 格式指定，且圖片必須是 Android 應用程式本機的可繪製圖示資源。

以下是使用者裝置上大致的視覺效果：

簡單的兩部裝置的繪圖，其中一部顯示自訂圖示和顏色

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: '`$FooCorp` up 1.43% on the day',
    body: 'FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  android: {
    notification: {
      icon: 'stock_ticker_update',
      color: '#7e55c3'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

Java

Message message = Message.builder()
    .setNotification(Notification.builder()
        .setTitle("$GOOG up 1.43% on the day")
        .setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
        .build())
    .setAndroidConfig(AndroidConfig.builder()
        .setTtl(3600 * 1000)
        .setNotification(AndroidNotification.builder()
            .setIcon("stock_ticker_update")
            .setColor("#f45342")
            .build())
        .build())
    .setApnsConfig(ApnsConfig.builder()
        .setAps(Aps.builder()
            .setBadge(42)
            .build())
        .build())
    .setTopic("industry-tech")
    .build();FirebaseMessagingSnippets.java

Python

message = messaging.Message(
    notification=messaging.Notification(
        title='$GOOG up 1.43% on the day',
        body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
    ),
    android=messaging.AndroidConfig(
        ttl=datetime.timedelta(seconds=3600),
        priority='normal',
        notification=messaging.AndroidNotification(
            icon='stock_ticker_update',
            color='#f45342'
        ),
    ),
    apns=messaging.APNSConfig(
        payload=messaging.APNSPayload(
            aps=messaging.Aps(badge=42),
        ),
    ),
    topic='industry-tech',
)cloud_messaging.py

Go

oneHour := time.Duration(1) * time.Hour
badge := 42
message := &messaging.Message{
	Notification: &messaging.Notification{
		Title: "$GOOG up 1.43% on the day",
		Body:  "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
	},
	Android: &messaging.AndroidConfig{
		TTL: &oneHour,
		Notification: &messaging.AndroidNotification{
			Icon:  "stock_ticker_update",
			Color: "#f45342",
		},
	},
	APNS: &messaging.APNSConfig{
		Payload: &messaging.APNSPayload{
			Aps: &messaging.Aps{
				Badge: &badge,
			},
		},
	},
	Topic: "industry-tech",
}messaging.go

C#

var message = new Message
{
    Notification = new Notification()
    {
        Title = "$GOOG up 1.43% on the day",
        Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
    },
    Android = new AndroidConfig()
    {
        TimeToLive = TimeSpan.FromHours(1),
        Notification = new AndroidNotification()
        {
            Icon = "stock_ticker_update",
            Color = "#f45342",
        },
    },
    Apns = new ApnsConfig()
    {
        Aps = new Aps()
        {
            Badge = 42,
        },
    },
    Topic = "industry-tech",
};FirebaseMessagingSnippets.cs

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"`$FooCorp` up 1.43% on the day",
       "body":"FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day."
     },
     "android":{
       "notification":{
         "icon":"stock_ticker_update",
         "color":"#7e55c3"
       }
     }
   }
 }

如要進一步瞭解訊息主體中特定平台區塊可用的鍵，請參閱 HTTP v1 參考說明文件。

範例：含有自訂圖片的通知訊息

以下範例傳送要求會將通用通知標題傳送至所有平台，但同時也會傳送圖片。以下是使用者裝置上大致的視覺效果：

在顯示通知中顯示圖片的簡易繪圖功能

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Sparky says hello!'
  },
  android: {
    notification: {
      imageUrl: 'https://foo.bar.pizza-monster.png'
    }
  },
  apns: {
    payload: {
      aps: {
        'mutable-content': 1
      }
    },
    fcm_options: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  webpush: {
    headers: {
      image: 'https://foo.bar.pizza-monster.png'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Sparky says hello!",
     },
     "android":{
       "notification":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "mutable-content":1
         }
       },
       "fcm_options": {
           "image":"https://foo.bar/pizza-monster.png"
       }
     },
     "webpush":{
       "headers":{
         "image":"https://foo.bar/pizza-monster.png"
       }
     }
   }
 }

如要進一步瞭解訊息主體中特定平台區塊可用的鍵，請參閱 HTTP v1 參考說明文件。

範例：含有相關點擊動作的通知訊息

下列範例傳送要求會將通用通知標題傳送至所有平台，但也會傳送一項動作，讓應用程式用於回應使用者與通知互動。以下是使用者裝置視覺效果的概略說明：

簡單的圖示，顯示使用者輕觸開啟網頁的動作

Node.js

const topicName = 'industry-tech';

const message = {
  notification: {
    title: 'Breaking News....'
  },
  android: {
    notification: {
      clickAction: 'news_intent'
    }
  },
  apns: {
    payload: {
      aps: {
        'category': 'INVITE_CATEGORY'
      }
    }
  },
  webpush: {
    fcmOptions: {
      link: 'breakingnews.html'
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
     "topic":"industry-tech",
     "notification":{
       "title":"Breaking News...",
     },
     "android":{
       "notification":{
         "click_action":"news_intent"
       }
     },
     "apns":{
       "payload":{
         "aps":{
           "category" : "INVITE_CATEGORY"
         }
       },
     },
     "webpush":{
       "fcm_options":{
         "link":"breakingnews.html"
       }
     }
   }
 }

如要進一步瞭解訊息主體中特定平台區塊可用的鍵，請參閱 HTTP v1 參考說明文件。

範例：含有本地化選項的通知訊息

以下範例傳送要求會傳送本地化選項，讓用戶端顯示本地化訊息。以下是使用者裝置上大致的視覺效果：

簡單的圖表，顯示兩部裝置以英文和西班牙文顯示文字

Node.js

var topicName = 'industry-tech';

var message = {
  android: {
    ttl: 3600000,
    notification: {
      bodyLocKey: 'STOCK_NOTIFICATION_BODY',
      bodyLocArgs: ['FooCorp', '11.80', '835.67', '1.43']
    }
  },
  apns: {
    payload: {
      aps: {
        alert: {
          locKey: 'STOCK_NOTIFICATION_BODY',
          locArgs: ['FooCorp', '11.80', '835.67', '1.43']
        }
      }
    }
  },
  topic: topicName,
};

getMessaging().send(message)
  .then((response) => {
    // Response is a message ID string.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

REST

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1

Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
  "message":{
             "topic":"Tech",
             "android":{
               "ttl":"3600s",
               "notification":{
                 "body_loc_key": "STOCK_NOTIFICATION_BODY",
                 "body_loc_args":  ["FooCorp", "11.80", "835.67", "1.43"],
               },
             },
             "apns":{
               "payload":{
                 "aps":{
                   "alert" : {
                     "loc-key": "STOCK_NOTIFICATION_BODY",
                     "loc-args":  ["FooCorp", "11.80", "835.67", "1.43"],
                    },
                 },
               },
             },
  },
}'

如要完整瞭解訊息內文中平台特定區塊可用的金鑰，請參閱 HTTP v1 參考說明文件。

HTTP v1 API 的 REST 錯誤代碼

HTTP v1 API 的 HTTP 錯誤回應包含錯誤代碼、錯誤訊息和錯誤狀態。這些資料也可能包含 details 陣列，其中包含更多錯誤詳細資料。

以下是兩個錯誤回應範例：

範例 1：HTTP v1 API 要求的錯誤回應，資料訊息中包含無效值

{
  "error": {
    "code": 400,
    "message": "Invalid value at 'message.data[0].value' (TYPE_STRING), 12",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.BadRequest",
        "fieldViolations": [
          {
            "field": "message.data[0].value",
            "description": "Invalid value at 'message.data[0].value' (TYPE_STRING), 12"
          }
        ]
      }
    ]
  }
}

示例 2：來自 HTTP v1 API 要求但註冊權杖無效的錯誤回應

{
  "error": {
    "code": 400,
    "message": "The registration token is not a valid FCM registration token",
    "status": "INVALID_ARGUMENT",
    "details": [
      {
        "@type": "type.googleapis.com/google.firebase.fcm.v1.FcmError",
        "errorCode": "INVALID_ARGUMENT"
      }
    ]
   }
}

請注意，兩則訊息的代碼和狀態相同，但 details 陣列包含不同型別的值。第一個範例是 type.googleapis.com/google.rpc.BadRequest 類型，表示要求值發生錯誤。第二個範例的類型為 type.googleapis.com/google.firebase.fcm.v1.FcmError，有 FCM 專屬錯誤。對於許多錯誤，詳細資料陣列會包含偵錯和找出解決方案所需的資訊。

下表列出 FCM v1 REST API 錯誤代碼和說明。

錯誤代碼	說明和解決步驟
`UNSPECIFIED_ERROR`沒有有關這個錯誤的詳細資訊。	無
`INVALID_ARGUMENT` (HTTP 錯誤代碼 = 400) 要求參數無效。系統會傳回 `google.rpc.BadRequest` 類型的擴充功能，以指定哪個欄位無效。	可能的原因包括註冊無效、套件名稱無效、訊息過大、資料鍵無效、TTL 無效或其他參數無效。無效的註冊：請檢查您傳遞至伺服器的註冊權杖格式。請確認該權杖與用戶端應用程式透過 FCM 註冊時收到的註冊權杖相符。請勿截斷符記或新增其他字元。套件名稱無效：請確認訊息是傳送至註冊權杖，其套件名稱與要求中傳送的值相符。訊息過大：請確認訊息中包含的酬載資料總大小未超過 FCM 限制：大多數訊息為 4096 位元組，針對主題的訊息則為 2048 位元組。包括鍵和值。無效的資料鍵：請確認酬載資料不含有 FCM 內部使用的鍵 (例如 from、gcm 或任何前面有 google 字樣的值)。請注意，FCM 也會使用部分字詞 (例如 collapse_key)，但這些字詞在酬載中是允許的，在這種情況下，酬載值會被 FCM 值覆寫。無效的 TTL：請確認 ttl 中使用的值為整數，代表的時間長度為 0 到 2,419,200 秒 (4 週) 之間。無效的參數：請確認提供的參數名稱和類型正確無誤。
`UNREGISTERED` (HTTP 錯誤代碼 = 404) 應用程式執行個體已從 FCM 取消註冊。這通常表示所使用的權杖已失效，必須使用新的權杖。	這個錯誤可能是因為缺少註冊權杖，或是未註冊的權杖。未註冊：如果訊息的目標是 `token` 值，請確認要求包含註冊權杖。未註冊：現有的註冊權杖可能會在許多情況下失效，包括： - 如果用戶端應用程式取消註冊 FCM。 - 如果用戶解除安裝應用程式，系統就會自動取消註冊用戶端應用程式。舉例來說，如果在 iOS 上，APNs 意見回饋服務回報 APNs 權杖無效。 - 如果註冊權杖到期 (例如 Google 可能決定重新整理註冊權杖，或是 iOS 裝置的 APN 權杖到期)。 - 如果用戶端應用程式已更新，但新版本未設定為接收訊息。在上述所有情況下，請從應用程式伺服器中移除此註冊權杖，並停止使用該權杖傳送訊息。
`SENDER_ID_MISMATCH` (HTTP 錯誤代碼 = 403) 已驗證的寄件者 ID 與註冊權杖的寄件者 ID 不同。	註冊權杖會與特定一組寄件者相關聯。用戶端應用程式註冊 FCM 時，必須指定哪些寄件者可以傳送訊息。傳送訊息至用戶端應用程式時，請使用其中一個傳送者 ID。如果切換至其他傳送者，現有的註冊權杖將無法運作。
`QUOTA_EXCEEDED` (HTTP 錯誤代碼 = 429) 已超過郵件目標的傳送上限。系統會傳回 `google.rpc.QuotaFailure` 類型的擴充功能，指出超過的配額。	造成這項錯誤的原因可能是訊息頻率超出配額、超過裝置訊息頻率配額，或是超過主題訊息頻率配額。超過郵件傳送率：訊息傳送率過高。您必須降低整體傳送訊息的頻率。使用指數輪詢時，至少須有 1 分鐘的初始延遲時間，才能重試遭拒的訊息。裝置訊息傳送頻率超出上限：傳送至特定裝置的訊息頻率過高。請參閱「對單一裝置的訊息傳送頻率限制」一文。請減少傳送至此裝置的訊息數量，並使用指數輪詢重試傳送。主題訊息比率超出上限：向特定主題訂閱者的訊息比率過高。減少為這個主題傳送的訊息數量，並使用指數輪詢，以 1 分鐘的初始延遲時間重試傳送。
`UNAVAILABLE` (HTTP 錯誤代碼 = 503) 伺服器超載。	伺服器無法及時處理要求。重試相同要求，但您必須： - 如果 FCM 連線伺服器的回應中包含 Retry-After 標頭，請遵循該標頭。 - 在重試機制中實作指數輪詢。(舉例來說，如果您在第一次重試前等待了 1 秒，請等待至少 2 秒再進行下一次，接著再等待 4 秒，依此類推)。如果您傳送多則訊息，建議您採用抖動技術。詳情請參閱「處理重試」。造成問題的寄件者可能會遭到拒絕。
`INTERNAL` (HTTP 錯誤代碼 = 500) 發生不明的內部錯誤。	伺服器在處理要求時發生錯誤，您可以按照「處理重試」一節中的建議，重試相同要求。如果錯誤持續發生，請與 Firebase 支援團隊聯絡。
`THIRD_PARTY_AUTH_ERROR` (HTTP 錯誤代碼 = 401) APNs 憑證或網路推播驗證金鑰無效或遺失。	無法傳送指定 iOS 裝置的訊息，或發送網頁推送註冊。檢查開發和正式版憑證是否有效。

管理員錯誤代碼

下表列出 Firebase Admin FCM API 錯誤代碼和說明，包括建議的解決步驟。

錯誤代碼	說明和解決步驟
`messaging/invalid-argument`	提供給 FCM 方法的引數無效。錯誤訊息應包含其他資訊。
`messaging/invalid-recipient`	指定的訊息收件者無效。錯誤訊息應包含其他資訊。
`messaging/invalid-payload`	提供的訊息酬載物件無效。錯誤訊息應包含額外資訊。
`messaging/invalid-data-payload-key`	資料訊息酬載包含無效的鍵。如要瞭解受限制的鍵，請參閱 `DataMessagePayload` 的參考說明文件。
`messaging/payload-size-limit-exceeded`	提供的訊息酬載超過 FCM 大小限制。大多數訊息的限制為 4096 個位元組。傳送至主題的訊息上限為 2048 個位元組。總酬載大小包含鍵和值。
`messaging/invalid-options`	提供的訊息選項物件無效。錯誤訊息應包含其他資訊。
`messaging/invalid-registration-token`	提供的註冊權杖無效。請確認這個 ID 與用戶端應用程式透過 FCM 註冊時收到的註冊權杖相符。請勿截斷或新增其他字元。
`messaging/registration-token-not-registered`	提供的註冊權杖尚未註冊。先前有效的註冊權杖可能會因各種原因而註銷，包括：用戶端應用程式已從 FCM 取消註冊。系統會自動取消註冊用戶端應用程式。使用者解除安裝應用程式，或是在 Apple 平台上，如果 APNs 意見回饋服務回報 APNs 權杖無效，就可能發生這種情況。註冊權杖已過期。舉例來說，Google 可能會決定更新註冊權杖，或是 Apple 裝置的 APN 權杖可能已過期。用戶端應用程式已更新，但新版本並未設定為接收訊息。在所有這些情況下，請移除這個註冊權杖，並停止使用該權杖傳送訊息。
`messaging/invalid-package-name`	訊息已傳送至註冊權杖，但該權杖的套件名稱與提供的 `restrictedPackageName` 選項不符。
`messaging/message-rate-exceeded`	傳送給特定目標的訊息比率過高。請減少傳送至此裝置或主題的訊息數量，並不要立即嘗試傳送至這個目標。
`messaging/device-message-rate-exceeded`	傳送至特定裝置的訊息比率過高。請減少傳送至這部裝置的訊息數量，並不要立即嘗試傳送至這部裝置。
`messaging/topics-message-rate-exceeded`	特定主題的訊息訂閱者比率過高。減少為這個主題傳送的訊息數量，並且不要立即重試傳送至這個主題。
`messaging/too-many-topics`	註冊權杖已訂閱的話題數量已達上限，無法再訂閱其他話題。
`messaging/invalid-apns-credentials`	無法傳送指定 Apple 裝置的訊息，因為必要的 APNs SSL 憑證未上傳或已過期。檢查開發和正式版憑證的有效性。
`messaging/mismatched-credential`	用於驗證此 SDK 的憑證沒有權限傳送訊息至對應於所提供註冊權杖的裝置。請確認憑證和註冊權杖都屬於同一個 Firebase 專案。如要瞭解如何驗證 Firebase Admin SDK，請參閱「將 Firebase 新增至應用程式」一文。
`messaging/authentication-error`	SDK 無法向 FCM 伺服器進行驗證。請務必使用具備適當權限 (可傳送 FCM 訊息) 的憑證，驗證 Firebase Admin SDK。如要瞭解如何驗證 Firebase Admin SDK，請參閱「將 Firebase 新增至應用程式」一文。
`messaging/server-unavailable`	FCM 伺服器無法及時處理要求。您應重試相同要求，但必須：如果 `Retry-After` 標頭包含在 FCM 連線伺服器的回應中，請遵循該標頭。在重試機制中實作指數輪詢。舉例來說，如果您在第一次重試前等待一秒，請在下次重試前等待至少兩秒，然後是四秒，依此類推。如果要傳送多則訊息，請以額外隨機金額分別延遲每則訊息，以免同時對所有訊息發出新的要求。造成問題的寄件者可能會遭到封鎖。
`messaging/internal-error`	FCM 伺服器在處理要求時發生錯誤。您可以按照上述 `messaging/server-unavailable` 列中列出的規定，重試相同要求。如果錯誤仍未解決，請向我們的錯誤報告支援管道回報問題。
`messaging/unknown-error`	系統傳回不明的伺服器錯誤。如需更多詳細資訊，請參閱錯誤訊息中的原始伺服器回應。如果您收到這則錯誤訊息，請將完整的錯誤訊息回報給我們的錯誤報告支援管道。

使用舊版應用程式伺服器通訊協定傳送訊息

如果您目前使用舊版通訊協定，請按照本節所述建構訊息要求。請注意，如果您透過 HTTP 傳送至多個平台，v1 通訊協定可大幅簡化訊息要求。

傳送訊息至特定裝置

如要傳送訊息至特定裝置，請將 to 金鑰設為特定應用程式執行個體的註冊權杖。請參閱平台的用戶端設定資訊，進一步瞭解註冊權杖。

HTTP POST 要求

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{ "data": {
    "score": "5x1",
    "time": "15:10"
  },
  "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
}

HTTP 回應

{ "multicast_id": 108,
  "success": 1,
  "failure": 0,
  "results": [
    { "message_id": "1:08" }
  ]
}

XMPP 訊息

<message id="">
  <gcm xmlns="google:mobile:data">
    { "data": {
      "score": "5x1",
      "time": "15:10"
    },
    "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
  </gcm>
</message>

XMPP 回應

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "from":"REGID",
      "message_id":"m-1366082849205"
      "message_type":"ack"
  }
  </gcm>
</message>

XMPP 連線伺服器提供其他回應選項。請參閱「伺服器回應格式」。

如要瞭解傳送下游訊息至用戶端應用程式時可用的完整訊息選項清單，請參閱所選連線伺服器通訊協定的參考資訊，包括 HTTP 或 XMPP。

將訊息傳送至主題

向 Firebase Cloud Messaging 主題傳送訊息，與傳送訊息至個別裝置或使用者群組的做法非常類似。應用程式伺服器會將 to 索引鍵設為 /topics/yourTopic 等值。開發人員可以選擇任何符合規則運算式的主題名稱："/topics/[a-zA-Z0-9-_.~%]+"。

如要傳送至多個主題組合，應用程式伺服器必須將 condition 鍵 (而非 to 鍵) 設為指定目標主題的布林值條件。舉例來說，如要將訊息傳送至訂閱 TopicA 和 TopicB 或 TopicC 的裝置，請執行下列步驟：

'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

FCM 會先評估括號中的任何條件，然後從左到右評估運算式。在上述運算式中，訂閱任何單一主題的使用者都不會收到訊息。同樣地，未訂閱 TopicA 的使用者也不會收到訊息。以下組合可以接收：

TopicA 和 TopicB
TopicA 和 TopicC

條件運算式最多可包含五個主題，且支援使用括號。支援的運算子：&&、||。

主題 HTTP POST 要求

傳送至單一主題：

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

傳送給訂閱「狗」或「貓」主題的裝置：

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

主題 HTTP 回應

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

主題 XMPP 訊息

傳送至單一主題：

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

傳送至訂閱「dogs」或「cats」主題的裝置：

<message id="">
  <gcm xmlns="google:mobile:data">


  </gcm>
</message>

主題 XMPP 回應

// Success example:
{
  "message_id": "1023456"
}

// failure example:
{
  "error": "TopicsMessageRateExceeded"
}

FCM 伺服器傳回主題傳送要求成功或失敗回應前，最多可能會延遲 30 秒。請務必在要求中相應地設定應用程式伺服器的逾時值。

傳送訊息至裝置群組

使用已淘汰的舊版 API 將訊息傳送至裝置群組，與傳送訊息至個別裝置非常相似。將 to 參數設為裝置群組的專屬通知索引鍵。本節的範例說明如何透過舊版 HTTP 和 XMPP 通訊協定，將資料訊息傳送至裝置群組。

裝置群組 HTTP POST 要求

https://fcm.googleapis.com/fcm/send
Content-Type:application/json
Authorization:key=AIzaSyZ-1u...0GBYzPu7Udno5aA

{
  "to": "aUniqueKey",
  "data": {
    "hello": "This is a Firebase Cloud Messaging Device Group Message!",
   }
}

裝置群組 HTTP 回應

以下是「成功」的範例：notification_key 有 2 個相關聯的註冊權杖，且訊息已成功傳送至這 2 個權杖：

{
  "success": 2,
  "failure": 0
}

以下是「部分成功」的範例：notification_key 有 3 個相關聯的註冊權杖。訊息僅成功傳送至 1 個註冊符記。回應訊息會列出未能收到訊息的註冊符記 (registration_ids)：

{
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

如果訊息無法傳送至與 notification_key 相關聯的一或多個註冊符記，應用程式伺服器應在重試之間使用延遲。

如果伺服器嘗試將訊息傳送至沒有成員的裝置群組，回應會如下所示，成功和失敗的數量皆為 0：

{
  "success": 0,
  "failure": 0
}

裝置群組 XMPP 訊息

<message id="">
  <gcm xmlns="google:mobile:data">
  {
      "to": "aUniqueKey",
      "message_id": "m-1366082849205" ,
      "data": {
          "hello":"This is a Firebase Cloud Messaging Device Group Message!"
      }
  }
  </gcm>
</message>

裝置群組 XMPP 回應

當訊息成功傳送至群組中的任一裝置時，XMPP 連線伺服器會傳回 ACK。如果傳送給群組中所有裝置的所有訊息都失敗，XMPP 連線伺服器會傳回 NACK。

以下是「成功」的範例：notification_key 有 3 個相關聯的註冊權杖，且訊息已成功傳送至所有權杖：

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success": 3,
  "failure": 0,
  "message_id": "m-1366082849205"
}

以下是「部分成功」的範例：notification_key 有 3 個相關聯的註冊權杖。系統只將訊息傳送至 1 個註冊符記。回應訊息會列出無法接收訊息的註冊符記：

{
  "from": "aUniqueKey",
  "message_type": "ack",
  "success":1,
  "failure":2,
  "failed_registration_ids":[
     "regId1",
     "regId2"
  ]
}

當 FCM 連線伺服器無法傳送至群組中的所有裝置時。應用程式伺服器會收到 nack 回應。

如需完整的訊息選項清單，請參閱所選連線伺服器通訊協定的參考資訊，包括 HTTP 或 XMPP。

Firebase Admin SDK 舊式傳送方法

Firebase Admin Node.js SDK 支援根據舊版 FCM 伺服器 API 傳送 (FCM) 訊息的方法。相較於 send() 方法，這些方法接受的引數並不相同。請盡可能使用 send() 方法，並且只在傳送訊息至個別裝置或裝置群組時，才使用本頁所述的方法。

傳送至個別裝置

您可以將註冊權杖傳遞至 sendToDevice() 方法，以便傳送訊息至該裝置：

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device corresponding to the provided
// registration token.
getMessaging().sendToDevice(registrationToken, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDevice() 方法也可以傳遞註冊權杖陣列，而非只傳送單一註冊權杖，藉此傳送多點傳播訊息 (也就是向多部裝置傳送訊息)：

Node.js

// These registration tokens come from the client FCM SDKs.
const registrationTokens = [
  'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...',
  // ...
  'ecupwIfBy1w:APA91bFtuMY7MktgxA3Au_Qx7cKqnf...'
];

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the devices corresponding to the provided
// registration tokens.
getMessaging().sendToDevice(registrationTokens, payload)
  .then((response) => {
    // See the MessagingDevicesResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDevice() 方法會傳回 promise，該 promise 會使用包含 FCM 回應的 MessagingDevicesResponse 物件解析。傳遞單一註冊符記或註冊符記陣列時，傳回類型會採用相同的格式。

在某些情況下 (例如驗證錯誤或頻率限制)，會導致整個訊息無法處理。在這類情況下，sendToDevice() 傳回的承諾會遭到拒絕，並顯示錯誤。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱「Admin FCM API 錯誤」。

傳送到裝置群組

sendToDeviceGroup() 方法可讓您指定裝置群組的通知鍵，藉此將訊息傳送至裝置群組：

Node.js

// See the "Managing device groups" link above on how to generate a
// notification key.
const notificationKey = 'some-notification-key';

// See the "Defining the message payload" section below for details
// on how to define a message payload.
const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

// Send a message to the device group corresponding to the provided
// notification key.
getMessaging().sendToDeviceGroup(notificationKey, payload)
  .then((response) => {
    // See the MessagingDeviceGroupResponse reference documentation for
    // the contents of response.
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

sendToDeviceGroup() 方法會傳回 promise，該 promise 會使用包含 FCM 回應的 MessagingDevicesResponse 物件解析。

在某些情況下，例如驗證錯誤或速率限制，會導致整個郵件無法處理。在這些情況下，sendToDeviceGroup() 傳回的 promise 會遭到拒絕，並顯示錯誤訊息。如需完整的錯誤代碼清單 (包括說明和解決步驟)，請參閱「Admin FCM API 錯誤」。

定義訊息酬載

上述方法以 FCM 舊版通訊協定為基礎，可接受訊息酬載做為第二個引數，並支援通知和資料訊息。您可以使用 data 和 / 或 notification 鍵建立物件，指定一或兩種訊息類型。例如，以下說明如何定義不同類型的訊息酬載：

通知訊息

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  }
};

資料訊息

const payload = {
  data: {
    score: '850',
    time: '2:45'
  }
};

合併訊息

const payload = {
  notification: {
    title: '$FooCorp up 1.43% on the day',
    body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
  },
  data: {
    stock: 'GOOG',
    open: '829.62',
    close: '635.67'
  }
};

通知訊息酬載具有預先定義的有效屬性子集，但會因您指定的行動作業系統而略有不同。如需完整清單，請參閱 NotificationMessagePayload 的參考文件。

資料訊息酬載是由自訂鍵/值組合組成，但有一些限制，包括所有值都必須是字串。如需限制的完整清單，請參閱 DataMessagePayload 的參考說明文件。

定義訊息選項

上述方法是以 FCM 舊版通訊協定為基礎，可接受可選的第三個引數，用於指定訊息的部分選項。舉例來說，以下範例會將高優先順序訊息傳送至 24 小時後會到期的裝置：

Node.js

// This registration token comes from the client FCM SDKs.
const registrationToken = 'bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1...';

// See the "Defining the message payload" section above for details
// on how to define a message payload.
const payload = {
  notification: {
    title: 'Urgent action needed!',
    body: 'Urgent action is needed to prevent your account from being disabled!'
  }
};

// Set the message as high priority and have it expire after 24 hours.
const options = {
  priority: 'high',
  timeToLive: 60 * 60 * 24
};

// Send a message to the device corresponding to the provided
// registration token with the provided options.
getMessaging().sendToDevice(registrationToken, payload, options)
  .then((response) => {
    console.log('Successfully sent message:', response);
  })
  .catch((error) => {
    console.log('Error sending message:', error);
  });

如需可用選項的完整清單，請參閱 MessagingOptions 的參考說明文件。